Link to PySPEDAS null point solver from our documentation & notebook
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 711
- Forks
- 375
- Avg merge
- 3h 2m
- Merged PRs (30d)
- 8
Description
There is soon-to-be-released functionality in PySPEDAS to find magnetic null points in multipoint spacecraft data (specifically 4-point measurements from MMS and Cluster). (Thank you, @jameswilburlewis!) We should add a link to the PySPEDAS functionality in PlasmaPy's null point finder documentation. We can probably link directly to the functions if we add PySPEDAS to our intersphinx (and hoverxref-intersphinx?) configuration.
It would also be helpful to clarify that the null point solver in PlasmaPy is intended for gridded data such as from a numerical simulation.
We'll need to wait until the next feature release of PySPEDAS before doing this.
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with PlasmaPy's null point finder documentation and the intersphinx and hoverxref-intersphinx configuration. After PySPEDAS's next feature release, link to its null point solver functionality, clarify that PlasmaPy's solver targets gridded numerical-simulation data, and update the referenced notebook as appropriate.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- python
- Domain
- documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 50/100