Add a new topic guide for the 2024 Eclipse

Open
#7,387 14 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
5/5
Estimated time
Over a week
Newbie friendliness
35/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Tech stack
python
Domain
documentation

Research direction

Start by reviewing the linked solar-eclipse repository and SunPy’s existing topic-guide and gallery structure to identify content for migration. Done means a published 2024 Eclipse guide includes the requested eclipse map, photograph-coordinate guide, and image-processing examples, with a decision on the old repository.

Written by the indexing model from the issue text.

Description

Effort Medium Package Intermediate Priority Medium Solar Physics Knowledge
Provide a general description of the issue or problem.

Having a new topic guide for the eclipse would be nice to be able to advertise SunPy and what SunPy can provide to support the eclipse that is occurring in April 2024. We could create a press release and share the link which would feature code examples and gallery examples. Some content already exists in the solar-eclipse repo. It needs to be updated and content migrated. This repo could then be made private or deleted.

Some additional content that could be added

  • A recreation an eclipse path map such as this one.
  • A guide on how to import a photograph into a Map and determine its coordinates
  • Example processing steps to be performed on an eclipse photograph like stacking, flat-fielding, and sharpening
Dominant language
Python
Stars
1k
Forks
682
Avg merge
1d 17h
Merged PRs (30d)
17

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from sunpy/sunpy

All issues in sunpy/sunpy

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.