solarmach documentation

The Solar MAgnetic Connection Haus (Solar-MACH) tool is a multi-spacecraft longitudinal configuration plotter. This is the documentation of the pip/conda package of Solar-MACH, called solarmach. For the corresponding streamlit repository, which is used for solar-mach.github.io, see github.com/jgieseler/Solar-MACH.

Note

Please cite the following paper if you use solarmach in your publication:

Gieseler, J., Dresing, N., Palmroos, C., von Forstner, J.L.F., Price, D.J., Vainio, R. et al. (2022). Solar-MACH: An open-source tool to analyze solar magnetic connection configurations. Front. Astronomy Space Sci. 9. doi:10.3389/fspas.2022.1058810

Contents:

• Installation
• Usage
  • 1. Minimal example
  • 2. Example with all the details
  • 3. Example using Stonyhurst coordinates for reference
  • 4. Only obtain data as Pandas DataFrame
  • 5. Advanced plotting options
    • 5.1 Example 1: plot cone-shaped area
    • 5.2 Example 2: shade area between two Parker spirals
    • 5.3 Example 3: plot background Parker spirals
  • 6. Advanced: edit the figure
  • 7. Ideas for further usage
    • 7.1 Loop over multiple datetimes (plots)
    • 7.2 Loop over multiple datetimes (only data)
• API reference

Acknowledgements

The Solar-MACH tool was originally developed at Kiel University, Germany and further discussed within the ESA Heliophysics Archives USer (HAUS) group.

This project has received funding from the European Union’s Horizon 2020 research and innovation programme under grant agreement No 101004159.

Powered by: