Metadata-Version: 2.4
Name: sunkit_magex
Version: 1.2.0
Summary: Solar Magnetic field Extrapolation
Author: David Stansby
Author-email: The SunPy Community <sunpy@googlegroups.com>
Project-URL: Homepage, https://sunpy.org
Project-URL: Download, https://pypi.org/project/sunkit-magex/
Project-URL: Source Code, https://github.com/sunpy/sunkit-magex/
Project-URL: Documentation, https://docs.sunpy.org/projects/sunkit-magex/en/stable/
Project-URL: Changelog, https://docs.sunpy.org/en/stable/whatsnew/changelog.html
Project-URL: Issue Tracker, https://github.com/sunpy/sunkit-magex/issues
Requires-Python: >=3.12
Description-Content-Type: text/x-rst
License-File: licenses/LICENSE.rst
Requires-Dist: astropy>=6.1.0
Requires-Dist: numpy>=1.26.0
Requires-Dist: scikit-image>=0.22.0
Requires-Dist: scipy>=1.12.0
Requires-Dist: streamtracer>=2.2.0
Requires-Dist: sunpy[map]>=7.0.0
Requires-Dist: matplotlib>=3.8.0
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-doctestplus; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: pytest-xdist; extra == "tests"
Requires-Dist: pytest-arraydiff; extra == "tests"
Requires-Dist: parfive; extra == "tests"
Requires-Dist: reproject; extra == "tests"
Requires-Dist: sunkit-magex[analytic]; extra == "tests"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-automodapi; extra == "docs"
Requires-Dist: sphinx-changelog; extra == "docs"
Requires-Dist: sunpy-sphinx-theme; extra == "docs"
Requires-Dist: packaging; extra == "docs"
Requires-Dist: reproject; extra == "docs"
Requires-Dist: sphinx-gallery; extra == "docs"
Requires-Dist: sphinx-autodoc-typehints; extra == "docs"
Requires-Dist: sunpy[map,net]!=6.0.0,>=6.0.1; extra == "docs"
Requires-Dist: sunkit-magex[all]; extra == "docs"
Provides-Extra: performance
Requires-Dist: numba; extra == "performance"
Provides-Extra: analytic
Requires-Dist: sympy; extra == "analytic"
Provides-Extra: all
Requires-Dist: sunkit-magex[analytic,performance]; extra == "all"
Provides-Extra: dev
Requires-Dist: sunkit-magex[all,docs,tests]; extra == "dev"
Dynamic: license-file

``sunkit-magex``
================

``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.

Installation
------------

We recommended following the `installation guide <https://docs.sunpy.org/projects/sunkit-magex/en/latest/installing.html>`__ in the documentation.

Usage
-----

If you are new to ``sunkit-magex``, the best place to start is the `example gallery <https://docs.sunpy.org/projects/sunkit-magex/en/latest/generated/gallery/index.html>`__.

Changes
-------

See our `changelog <https://docs.sunpy.org/projects/sunkit-magex/en/latest/whatsnew/changelog.html>`__.

Getting Help
------------

For more information or to ask questions about ``sunkit-magex`` or any other SunPy Project package, please check out:

-  The `#sunkit-magex:openastronomy.org`_ chat
-  `SunPy mailing list <https://groups.google.com/forum/#!forum/sunpy>`__
-  `SunPy Community forum <https://community.openastronomy.org/c/sunpy/5>`__


Usage of Generative AI
----------------------

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 <https://docs.sunpy.org/en/latest/dev_guide/contents/ai_usage.html>`__.

Contributing
------------

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`_.

.. _Developers Guide: https://docs.sunpy.org/en/latest/dev_guide/index.html
.. _`#sunkit-magex:openastronomy.org`: https://app.element.io/#/room/#sunkit-magex:openastronomy.org
.. _issues page: https://github.com/sunpy/sunkit-magex/issues
.. _Newcomers' guide: https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html

When you are interacting with the SunPy community you are asked at to follow our `code of conduct <https://sunpy.org/coc>`__.
