Metadata-Version: 2.1
Name: sunpy
Version: 5.1.0rc1
Summary: SunPy core package: Python for Solar Physics
Home-page: https://sunpy.org
Download-URL: https://pypi.org/project/sunpy/
Author: The SunPy Community
Author-email: sunpy@googlegroups.com
License: BSD 2-Clause
Project-URL: Source Code, https://github.com/sunpy/sunpy/
Project-URL: Documentation, https://docs.sunpy.org/
Project-URL: Changelog, https://docs.sunpy.org/en/stable/whatsnew/changelog.html
Project-URL: Issue Tracker, https://github.com/sunpy/sunpy/issues
Keywords: solar physics,solar,science,sun,wcs,coordinates
Platform: any
Classifier: Development Status :: 5 - Production/Stable
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.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Scientific/Engineering :: Physics
Provides: sunpy
Requires-Python: >=3.9
Description-Content-Type: text/x-rst
License-File: LICENSE.rst
Requires-Dist: astropy !=5.1.0,>=5.0.6
Requires-Dist: numpy >=1.21.0
Requires-Dist: packaging >=19.0
Requires-Dist: parfive[ftp] >=2.0.0
Provides-Extra: all
Requires-Dist: asdf-astropy >=0.1.1 ; extra == 'all'
Requires-Dist: asdf >=2.8.0 ; extra == 'all'
Requires-Dist: dask[array] >=2021.4.0 ; extra == 'all'
Requires-Dist: sqlalchemy >=1.3.4 ; extra == 'all'
Requires-Dist: scikit-image >=0.18.0 ; extra == 'all'
Requires-Dist: scipy !=1.10.0,>=1.7.0 ; extra == 'all'
Requires-Dist: glymur !=0.9.5,>=0.9.1 ; extra == 'all'
Requires-Dist: lxml >=4.8.0 ; extra == 'all'
Requires-Dist: matplotlib >=3.5.0 ; extra == 'all'
Requires-Dist: mpl-animators >=1.0.0 ; extra == 'all'
Requires-Dist: reproject ; extra == 'all'
Requires-Dist: beautifulsoup4 >=4.8.0 ; extra == 'all'
Requires-Dist: drms >=0.6.1 ; extra == 'all'
Requires-Dist: python-dateutil >=2.8.0 ; extra == 'all'
Requires-Dist: tqdm >=4.32.1 ; extra == 'all'
Requires-Dist: zeep >=3.4.0 ; extra == 'all'
Requires-Dist: cdflib !=0.4.0,!=1.0.0,>=0.3.20 ; extra == 'all'
Requires-Dist: h5netcdf >=0.11 ; extra == 'all'
Requires-Dist: h5py >=3.1.0 ; extra == 'all'
Requires-Dist: pandas >=1.2.0 ; extra == 'all'
Provides-Extra: asdf
Requires-Dist: asdf-astropy >=0.1.1 ; extra == 'asdf'
Requires-Dist: asdf >=2.8.0 ; extra == 'asdf'
Provides-Extra: dask
Requires-Dist: dask[array] >=2021.4.0 ; extra == 'dask'
Provides-Extra: database
Requires-Dist: sqlalchemy >=1.3.4 ; extra == 'database'
Provides-Extra: dev
Requires-Dist: asdf-astropy >=0.1.1 ; extra == 'dev'
Requires-Dist: asdf >=2.8.0 ; extra == 'dev'
Requires-Dist: dask[array] >=2021.4.0 ; extra == 'dev'
Requires-Dist: sqlalchemy >=1.3.4 ; extra == 'dev'
Requires-Dist: scikit-image >=0.18.0 ; extra == 'dev'
Requires-Dist: scipy !=1.10.0,>=1.7.0 ; extra == 'dev'
Requires-Dist: glymur !=0.9.5,>=0.9.1 ; extra == 'dev'
Requires-Dist: lxml >=4.8.0 ; extra == 'dev'
Requires-Dist: matplotlib >=3.5.0 ; extra == 'dev'
Requires-Dist: mpl-animators >=1.0.0 ; extra == 'dev'
Requires-Dist: reproject ; extra == 'dev'
Requires-Dist: beautifulsoup4 >=4.8.0 ; extra == 'dev'
Requires-Dist: drms >=0.6.1 ; extra == 'dev'
Requires-Dist: python-dateutil >=2.8.0 ; extra == 'dev'
Requires-Dist: tqdm >=4.32.1 ; extra == 'dev'
Requires-Dist: zeep >=3.4.0 ; extra == 'dev'
Requires-Dist: cdflib !=0.4.0,!=1.0.0,>=0.3.20 ; extra == 'dev'
Requires-Dist: h5netcdf >=0.11 ; extra == 'dev'
Requires-Dist: h5py >=3.1.0 ; extra == 'dev'
Requires-Dist: pandas >=1.2.0 ; extra == 'dev'
Requires-Dist: hvpy >=1.0.1 ; extra == 'dev'
Requires-Dist: hypothesis >=6.0.0 ; extra == 'dev'
Requires-Dist: jplephem ; extra == 'dev'
Requires-Dist: opencv-python ; extra == 'dev'
Requires-Dist: pytest-astropy >=0.8 ; extra == 'dev'
Requires-Dist: pytest-doctestplus >=0.5 ; extra == 'dev'
Requires-Dist: pytest-mock ; extra == 'dev'
Requires-Dist: pytest-mpl >=0.12 ; extra == 'dev'
Requires-Dist: pytest-xdist >=2.0 ; extra == 'dev'
Requires-Dist: pytest >=6.0 ; extra == 'dev'
Requires-Dist: spiceypy ; extra == 'dev'
Requires-Dist: packaging ; extra == 'dev'
Requires-Dist: ruamel.yaml ; extra == 'dev'
Requires-Dist: sphinx ; extra == 'dev'
Requires-Dist: sphinx-automodapi ; extra == 'dev'
Requires-Dist: importlib-resources <6 ; extra == 'dev'
Requires-Dist: sphinx-changelog ; extra == 'dev'
Requires-Dist: sphinx-copybutton ; extra == 'dev'
Requires-Dist: sphinx-design ; extra == 'dev'
Requires-Dist: sphinx-gallery >=0.13.0 ; extra == 'dev'
Requires-Dist: sphinxext-opengraph ; extra == 'dev'
Requires-Dist: sunpy-sphinx-theme >=2.0.0rc1 ; extra == 'dev'
Requires-Dist: sphinx-hoverxref ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: hvpy >=1.0.1 ; extra == 'docs'
Requires-Dist: packaging ; extra == 'docs'
Requires-Dist: ruamel.yaml ; extra == 'docs'
Requires-Dist: sphinx ; extra == 'docs'
Requires-Dist: sphinx-automodapi ; extra == 'docs'
Requires-Dist: importlib-resources <6 ; extra == 'docs'
Requires-Dist: sphinx-changelog ; extra == 'docs'
Requires-Dist: sphinx-copybutton ; extra == 'docs'
Requires-Dist: sphinx-design ; extra == 'docs'
Requires-Dist: sphinx-gallery >=0.13.0 ; extra == 'docs'
Requires-Dist: sphinxext-opengraph ; extra == 'docs'
Requires-Dist: spiceypy ; extra == 'docs'
Requires-Dist: sunpy-sphinx-theme >=2.0.0rc1 ; extra == 'docs'
Requires-Dist: sphinx-hoverxref ; extra == 'docs'
Provides-Extra: docs-gallery
Requires-Dist: astroquery ; extra == 'docs-gallery'
Requires-Dist: jplephem ; extra == 'docs-gallery'
Requires-Dist: mplcairo ; extra == 'docs-gallery'
Requires-Dist: opencv-python ; extra == 'docs-gallery'
Requires-Dist: reproject ; extra == 'docs-gallery'
Provides-Extra: image
Requires-Dist: scikit-image >=0.18.0 ; extra == 'image'
Requires-Dist: scipy !=1.10.0,>=1.7.0 ; extra == 'image'
Provides-Extra: jpeg2000
Requires-Dist: glymur !=0.9.5,>=0.9.1 ; extra == 'jpeg2000'
Requires-Dist: lxml >=4.8.0 ; extra == 'jpeg2000'
Provides-Extra: map
Requires-Dist: matplotlib >=3.5.0 ; extra == 'map'
Requires-Dist: mpl-animators >=1.0.0 ; extra == 'map'
Requires-Dist: reproject ; extra == 'map'
Requires-Dist: scipy !=1.10.0,>=1.7.0 ; extra == 'map'
Provides-Extra: net
Requires-Dist: beautifulsoup4 >=4.8.0 ; extra == 'net'
Requires-Dist: drms >=0.6.1 ; extra == 'net'
Requires-Dist: python-dateutil >=2.8.0 ; extra == 'net'
Requires-Dist: tqdm >=4.32.1 ; extra == 'net'
Requires-Dist: zeep >=3.4.0 ; extra == 'net'
Provides-Extra: spice
Requires-Dist: spiceypy ; extra == 'spice'
Provides-Extra: tests
Requires-Dist: hvpy >=1.0.1 ; extra == 'tests'
Requires-Dist: hypothesis >=6.0.0 ; extra == 'tests'
Requires-Dist: jplephem ; extra == 'tests'
Requires-Dist: opencv-python ; extra == 'tests'
Requires-Dist: pytest-astropy >=0.8 ; extra == 'tests'
Requires-Dist: pytest-doctestplus >=0.5 ; extra == 'tests'
Requires-Dist: pytest-mock ; extra == 'tests'
Requires-Dist: pytest-mpl >=0.12 ; extra == 'tests'
Requires-Dist: pytest-xdist >=2.0 ; extra == 'tests'
Requires-Dist: pytest >=6.0 ; extra == 'tests'
Requires-Dist: spiceypy ; extra == 'tests'
Provides-Extra: timeseries
Requires-Dist: cdflib !=0.4.0,!=1.0.0,>=0.3.20 ; extra == 'timeseries'
Requires-Dist: h5netcdf >=0.11 ; extra == 'timeseries'
Requires-Dist: h5py >=3.1.0 ; extra == 'timeseries'
Requires-Dist: matplotlib >=3.5.0 ; extra == 'timeseries'
Requires-Dist: pandas >=1.2.0 ; extra == 'timeseries'
Provides-Extra: visualization
Requires-Dist: matplotlib >=3.5.0 ; extra == 'visualization'
Requires-Dist: mpl-animators >=1.0.0 ; extra == 'visualization'

*********
``sunpy``
*********

|Latest Version| |DOI| |repostatus| |python|
|ci| |codecov| |Docs|
|matrix|
|Powered by NumFOCUS|

.. |Latest Version| image:: https://img.shields.io/pypi/v/sunpy.svg
   :target: https://pypi.python.org/pypi/sunpy/
.. |DOI| image:: https://zenodo.org/badge/2165383.svg
   :target: https://zenodo.org/badge/latestdoi/2165383
.. |matrix| image:: https://img.shields.io/matrix/sunpy:openastronomy.org.svg?colorB=%23FE7900&label=Chat&logo=matrix&server_fqdn=matrix.org
   :target: https://app.element.io/#/room/#sunpy:openastronomy.org
.. |codecov| image:: https://codecov.io/gh/sunpy/sunpy/branch/main/graph/badge.svg
   :target: https://codecov.io/gh/sunpy/sunpy
.. |Powered by NumFOCUS| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
   :target: https://numfocus.org
.. |CI| image:: https://github.com/sunpy/sunpy/actions/workflows/ci.yml/badge.svg?branch=main
   :target: https://github.com/sunpy/sunpy/actions/workflows/ci.yml
.. |Docs| image:: https://readthedocs.org/projects/sunpy/badge/?version=stable
   :target: https://docs.sunpy.org/en/stable/?badge=stable
   :alt: Documentation Status
.. |repostatus| image:: https://www.repostatus.org/badges/latest/active.svg
   :alt: Project Status: Active – The project has reached a stable, usable state and is being actively developed.
   :target: https://www.repostatus.org/#active
.. |python| image:: https://img.shields.io/pypi/pyversions/sunpy
   :alt: PyPI - Python Version

``sunpy`` is a Python software package that provides fundamental tools for accessing, loading and interacting with solar physics data in Python.
It is the core library of the `SunPy Project <https://sunpy.org/>`__.

For some examples of using ``sunpy`` see our `gallery <https://docs.sunpy.org/en/stable/generated/gallery/index.html>`__.
To see the latest changes in ``sunpy`` see our `changelog <https://docs.sunpy.org/en/stable/whatsnew/changelog.html>`__.

Installation
============

The recommended way to install ``sunpy`` is with `miniforge <https://github.com/conda-forge/miniforge#miniforge3>`__.
To install ``sunpy`` once miniforge is installed run the following command:

.. code:: bash

    $ conda install sunpy

For detailed installation instructions, see the `installation guide <https://docs.sunpy.org/en/stable/guide/installation.html>`__ in the ``sunpy`` docs.

Usage
=====

Here is a quick example of plotting an AIA image:

.. code:: python

   >>> import sunpy.map
   >>> from sunpy.data.sample import AIA_171_IMAGE
   >>>
   >>> import matplotlib.pyplot as plt
   >>>
   >>> aia = sunpy.map.Map(AIA_171_IMAGE)
   >>>
   >>> aia.plot()
   >>>
   >>> plt.show()

Getting Help
============

For more information or to ask questions about ``sunpy`` or any other SunPy library, check out:

-  `sunpy documentation <https://docs.sunpy.org/en/stable/>`__
-  `SunPy Chat`_
-  `SunPy mailing list <https://groups.google.com/forum/#!forum/sunpy>`__
-  `SunPy Community forum <https://community.openastronomy.org/c/sunpy/5>`__

Acknowledging or Citing ``sunpy``
=================================

If you use ``sunpy`` in your scientific work, we would appreciate your `citing it in your publications <https://sunpy.org/about#acknowledging-or-citing-sunpy>`__.
The continued growth and development of ``sunpy`` is dependent on the community being aware of ``sunpy``.

Contributing
============

If you would like to get involved, start by joining the `SunPy Chat`_ and check out our `Newcomers' guide <https://docs.sunpy.org/en/latest/dev_guide/contents/newcomers.html>`__.
This will walk you through getting set up for contributing.

Code of Conduct
===============

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

.. _SunPy Chat: https://app.element.io/#/room/#sunpy:openastronomy.org
