Metadata-Version: 2.4
Name: aiapy
Version: 0.12.0
Summary: Python library for AIA data analysis.
Author-email: "AIA Instrument Team @ LMSAL" <nfreij@set.org>
Project-URL: Homepage, https://aia.lmsal.com/
Project-URL: Source Code, https://github.com/LM-SAL/aiapy
Project-URL: Download, https://pypi.org/project/aiapy
Project-URL: Documentation, https://aiapy.readthedocs.io/en/stable/
Project-URL: Changelog, https://aiapy.readthedocs.io/en/stable/changelog.html
Project-URL: Issue Tracker, https://github.com/LM-SAL/aiapy/issues/
Keywords: solar physics,solar,science,NASA,SDO,AIA,solar dynamics observatory,atmospheric imaging assembly
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: BSD License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering :: Astronomy
Requires-Python: >=3.12
Description-Content-Type: text/x-rst
Requires-Dist: astropy>=7.1.1
Requires-Dist: numpy>=2.0.0
Requires-Dist: matplotlib>3.9.0
Requires-Dist: sunpy[image,map,net]>=7.0
Provides-Extra: all
Requires-Dist: aiapy; extra == "all"
Provides-Extra: performance
Requires-Dist: jax; extra == "performance"
Provides-Extra: performance-nvidia
Requires-Dist: jax[cuda13]; extra == "performance-nvidia"
Provides-Extra: performance-mac
Requires-Dist: jax-metal; sys_platform == "darwin" and extra == "performance-mac"
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: aiapy[all]; extra == "tests"
Requires-Dist: hissw; extra == "tests"
Requires-Dist: pytest-astropy; extra == "tests"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: sphinx-automodapi; extra == "docs"
Requires-Dist: sphinx-changelog; extra == "docs"
Requires-Dist: packaging; extra == "docs"
Requires-Dist: aiapy[all]; extra == "docs"
Requires-Dist: sphinx-copybutton; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: sphinx-gallery; extra == "docs"
Requires-Dist: sphinxext-opengraph; extra == "docs"
Requires-Dist: sunpy-sphinx-theme; extra == "docs"
Requires-Dist: sunpy-sphinx-theme; extra == "docs"
Provides-Extra: dev
Requires-Dist: aiapy[all,docs,tests]; extra == "dev"

=========
``aiapy``
=========

.. image:: https://github.com/LM-SAL/aiapy/actions/workflows/ci.yml/badge.svg
    :target: https://github.com/LM-SAL/aiapy/actions/workflows/ci.yml
    :alt: aiapy CI status

.. image:: https://readthedocs.org/projects/aiapy/badge/?version=stable
    :target: https://aiapy.readthedocs.io/en/stable/?badge=stable
    :alt: Documentation Status

.. image:: https://img.shields.io/pypi/v/aiapy.svg
    :target: https://pypi.org/project/aiapy/
    :alt: PyPI Project

.. image:: http://img.shields.io/badge/powered%20by-SunPy-orange.svg?style=flat
    :target: https://sunpy.org
    :alt: SunPy Powered

.. image:: https://codecov.io/gh/LM-SAL/aiapy/branch/main/graph/badge.svg
    :target: https://codecov.io/gh/LM-SAL/aiapy
    :alt: Codecov coverage

.. image:: https://zenodo.org/badge/DOI/10.5281/zenodo.10064346.svg
    :target: https://doi.org/10.5281/zenodo.10064346
    :alt: Zenodo DOI

.. image:: https://joss.theoj.org/papers/9bfcd1677e43046a5136766863419a04/status.svg
    :target: https://joss.theoj.org/papers/9bfcd1677e43046a5136766863419a04
    :alt: JOSS

``aiapy`` is a Python package for analyzing data from the Atmospheric Imaging Assembly (AIA) instrument onboard NASA's Solar Dynamics Observatory (SDO) spacecraft.
For more information, see the `aiapy documentation <https://aiapy.readthedocs.io/en/latest/>`__.
For some examples of using aiapy, see `our gallery <https://aiapy.readthedocs.io/en/latest/generated/gallery/index.html>`__.

Citing
------

If you use ``aiapy`` in your scientific work, we would appreciate you citing it in your publications.
The latest citation information can be found in the `documentation <https://aiapy.readthedocs.io/en/latest/citation.html>`__, or obtained with ``aiapy.__citation__``.

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

We expect authentic engagement in our community.
Be wary of posting output from large language models or similar generative AI as comments on GitHub or any other platforms, as such comments tend to be formulaic and low‑quality content.
**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! aiapy is open source, built on open source, and we'd love to have you hang out in our community.

Please checkout the `contributing guide <https://aiapy.readthedocs.io/en/latest/develop.html>`__ for more information on how to contribute to aiapy.

**Imposter syndrome disclaimer**: We want your help. No, really.

There may be a little voice inside your head that is telling you that you're not ready to be an open source contributor; that your skills aren't nearly good enough to contribute.
What could you possibly offer a project like this one?

We assure you - the little voice in your head is wrong.
If you can write code at all, you can contribute code to open source.
Contributing to open source projects is a fantastic way to advance one's coding skills.
Writing perfect code isn't the measure of a good developer (that would disqualify all of us!); it's trying to create something, making mistakes, and learning from those mistakes.
That's how we all improve, and we are happy to help others learn.

Being an open source contributor doesn't just mean writing code, either.
You can help out by writing documentation, tests, or even giving feedback about the project (and yes - that includes giving feedback about the contribution process).
Some of these contributions may be the most valuable to the project as a whole, because you're coming to the project with fresh eyes, so you can see the errors and assumptions that seasoned contributors have glossed over.

Note: This disclaimer was originally written by
`Adrienne Lowe <https://github.com/adriennefriend>`__ for a
`PyCon talk <https://www.youtube.com/watch?v=6Uj746j9Heo>`__, and was adapted by
irispy-lmsal based on its use in the README file for the
`MetPy project <https://github.com/Unidata/MetPy>`__.

License
-------

This project is Copyright (c) AIA Instrument Team @ LMSAL and licensed under
the terms of the BSD 3-Clause license. This package is based upon
the `Openastronomy packaging guide <https://github.com/OpenAstronomy/packaging-guide>`__
which is licensed under the BSD 3-clause licence. See the licenses folder for
more information.
