sunkit-magex is a Python software package that provides a set of tools for the modelling of magnetic field data.
It is a SunPy affiliated package and is built on top of sunpy and astropy.
Currently it only supports the potential field source surface (PFSS) model, but we hope to expand it to include other models in the future.
We recommended following the installation guide in the documentation.
If you are new to sunkit-magex, the best place to start is the example gallery.
See our changelog.
For more information or to ask questions about sunkit-magex or any other SunPy Project package, please check out:
We expect authentic engagement in our community. Do not post the output from Large Language Models or similar generative AI as code, issues or comments on GitHub or any other platform. If you use generative AI tools as an aid in developing code or documentation changes, ensure that you fully understand the proposed changes and can explain why they are the correct approach and an improvement to the current state. For more information see our documentation on fair and appropriate AI usage.
We love contributions! sunkit-magex is open source, built on open source, and we'd love to have you hang out in our community.
If you would like to get involved, check out the Developers Guide section of the SunPy docs. Stop by our chat room #sunkit-magex:openastronomy.org if you have any questions. Help is always welcome so let us know what you like to work on, or check out the issues page for the list of known outstanding items.
For more information on contributing to SunPy, please read our Newcomers' guide.
When you are interacting with the SunPy community you are asked at to follow our code of conduct.
