Metadata-Version: 2.1
Name: sunpy
Version: 1.1.0
Summary: "SunPy: Python for Solar Physics"
Home-page: https://sunpy.org
Author: The SunPy Community
Author-email: sunpy@googlegroups.com
License: BSD 2-Clause
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.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Topic :: Scientific/Engineering :: Physics
Provides: sunpy
Requires-Python: >=3.6
Description-Content-Type: text/x-rst
Requires-Dist: numpy (>=1.14.5)
Requires-Dist: scipy
Requires-Dist: matplotlib (>=1.3)
Requires-Dist: pandas
Requires-Dist: astropy (>=3.1)
Requires-Dist: parfive[ftp]
Requires-Dist: importlib-resources ; python_version < "3.8"
Provides-Extra: all
Requires-Dist: sqlalchemy ; extra == 'all'
Requires-Dist: scikit-image ; extra == 'all'
Requires-Dist: glymur ; extra == 'all'
Requires-Dist: beautifulsoup4 ; extra == 'all'
Requires-Dist: drms ; extra == 'all'
Requires-Dist: python-dateutil ; extra == 'all'
Requires-Dist: zeep ; extra == 'all'
Requires-Dist: tqdm ; extra == 'all'
Requires-Dist: asdf ; extra == 'all'
Requires-Dist: dask[array] ; extra == 'all'
Provides-Extra: asdf
Requires-Dist: asdf ; extra == 'asdf'
Provides-Extra: dask
Requires-Dist: dask[array] ; extra == 'dask'
Provides-Extra: database
Requires-Dist: sqlalchemy ; extra == 'database'
Provides-Extra: dev
Requires-Dist: sqlalchemy ; extra == 'dev'
Requires-Dist: scikit-image ; extra == 'dev'
Requires-Dist: glymur ; extra == 'dev'
Requires-Dist: beautifulsoup4 ; extra == 'dev'
Requires-Dist: drms ; extra == 'dev'
Requires-Dist: python-dateutil ; extra == 'dev'
Requires-Dist: zeep ; extra == 'dev'
Requires-Dist: tqdm ; extra == 'dev'
Requires-Dist: asdf ; extra == 'dev'
Requires-Dist: dask[array] ; extra == 'dev'
Requires-Dist: hypothesis ; extra == 'dev'
Requires-Dist: pytest ; extra == 'dev'
Requires-Dist: pytest-astropy ; extra == 'dev'
Requires-Dist: pytest-cov ; extra == 'dev'
Requires-Dist: pytest-mock ; extra == 'dev'
Requires-Dist: tox ; extra == 'dev'
Requires-Dist: tox-conda ; extra == 'dev'
Requires-Dist: ruamel.yaml ; extra == 'dev'
Requires-Dist: sphinx (>=2) ; extra == 'dev'
Requires-Dist: sphinx-astropy ; extra == 'dev'
Requires-Dist: sphinx-gallery ; extra == 'dev'
Requires-Dist: sunpy-sphinx-theme ; extra == 'dev'
Requires-Dist: towncrier ; extra == 'dev'
Provides-Extra: docs
Requires-Dist: ruamel.yaml ; extra == 'docs'
Requires-Dist: sphinx (>=2) ; extra == 'docs'
Requires-Dist: sphinx-astropy ; extra == 'docs'
Requires-Dist: sphinx-gallery ; extra == 'docs'
Requires-Dist: sunpy-sphinx-theme ; extra == 'docs'
Requires-Dist: towncrier ; extra == 'docs'
Provides-Extra: image
Requires-Dist: scikit-image ; extra == 'image'
Provides-Extra: jpeg2000
Requires-Dist: glymur ; extra == 'jpeg2000'
Provides-Extra: net
Requires-Dist: beautifulsoup4 ; extra == 'net'
Requires-Dist: drms ; extra == 'net'
Requires-Dist: python-dateutil ; extra == 'net'
Requires-Dist: zeep ; extra == 'net'
Requires-Dist: tqdm ; extra == 'net'
Provides-Extra: tests
Requires-Dist: hypothesis ; extra == 'tests'
Requires-Dist: pytest ; extra == 'tests'
Requires-Dist: pytest-astropy ; extra == 'tests'
Requires-Dist: pytest-cov ; extra == 'tests'
Requires-Dist: pytest-mock ; extra == 'tests'
Requires-Dist: tox ; extra == 'tests'
Requires-Dist: tox-conda ; extra == 'tests'

********
`SunPy`_
********

|Latest Version| |codecov| |matrix| |Research software impact| |DOI| |Powered by NumFOCUS|

.. |Latest Version| image:: https://img.shields.io/pypi/v/sunpy.svg
   :target: https://pypi.python.org/pypi/sunpy/
.. |matrix| image:: https://img.shields.io/matrix/sunpy:openastronomy.org.svg?colorB=%23FE7900&label=Chat&logo=matrix&server_fqdn=matrix.openastronomy.org
   :target: https://chat.openastronomy.org/#/room/#sunpy:openastronomy.org
.. |codecov| image:: https://codecov.io/gh/sunpy/sunpy/branch/master/graph/badge.svg
   :target: https://codecov.io/gh/sunpy/sunpy
.. |Research software impact| image:: http://depsy.org/api/package/pypi/sunpy/badge.svg
   :target: http://depsy.org/package/python/sunpy
.. |DOI| image:: https://zenodo.org/badge/2165383.svg
   :target: https://zenodo.org/badge/latestdoi/2165383
.. |Powered by NumFOCUS| image:: https://img.shields.io/badge/powered%20by-NumFOCUS-orange.svg?style=flat&colorA=E1523D&colorB=007D8A
   :target: https://numfocus.org
.. |Binder| image:: https://mybinder.org/badge_logo.svg
   :target: https://mybinder.org/v2/gh/sunpy/sunpy/master?filepath=examples

SunPy is an open-source Python library for Solar Physics data analysis and visualization.
Our homepage `SunPy`_ has more information about the project.

For some examples of using SunPy see our `gallery`_, to see the latest changes in SunPy see our `Changelog`_.

.. _SunPy: https://sunpy.org
.. _gallery: https://docs.sunpy.org/en/stable/generated/gallery/index.html
.. _Changelog: https://docs.sunpy.org/en/latest/whatsnew/changelog.html

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

The recommended way to install SunPy is with `conda`_.
To install SunPy once conda is installed run the following two commands:

.. code:: bash

    $ conda config --append channels conda-forge
    $ conda install sunpy

For detailed installation instructions, see the `installation guide`_ in the SunPy docs.

.. _conda: https://www.anaconda.com/distribution/
.. _installation guide: https://docs.sunpy.org/en/latest/guide/installation/index.html

Developing
==========

If you want to develop SunPy you will need to install from GitHub.
The best way to do this is to create a new conda environment and install the git version of SunPy in it:

.. warning::

    Do not clone the sunpy repository into ``$HOME/sunpy``. Depending on the operating system this location is used to store downloaded data files.
    This will cause conflicts later on, so the last argument (``sunpy-git``) on the ``git clone`` line will become the local folder name of the cloned repository.

.. code:: bash

    $ conda config --append channels conda-forge
    $ conda create -n sunpy-dev sunpy
    $ conda activate sunpy-dev
    $ conda remove sunpy
    $ git clone https://github.com/sunpy/sunpy.git sunpy-git
    $ cd sunpy-git
    $ pip install -e .[all,dev]

For detailed installation instructions, see the `Newcomers' guide`_ 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
    >>> aia = sunpy.map.Map(AIA_171_IMAGE)
    >>> aia.peek()

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

For more information or to ask questions about SunPy, check out:

-  `SunPy Documentation`_
-  `SunPy Matrix Channel`_
-  `SunPy Mailing List`_

.. _SunPy Documentation: https://docs.sunpy.org/en/stable/
.. _SunPy Matrix Channel: https://chat.openastronomy.org/#/room/#sunpy:openastronomy.org
.. _SunPy Mailing List: https://groups.google.com/forum/#!forum/sunpy

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

|Open Source Helpers|

If you would like to get involved, start by joining the `SunPy mailing list`_ and check out the `Developers Guide`_ section of the SunPy docs.
Stop by our chat room `#sunpy: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`_.

.. |Open Source Helpers| image:: https://www.codetriage.com/sunpy/sunpy/badges/users.svg
   :target: https://www.codetriage.com/sunpy/sunpy

.. _SunPy mailing list: https://groups.google.com/forum/#!forum/sunpy
.. _Developers Guide: https://docs.sunpy.org/en/latest/dev_guide/index.html
.. _`#sunpy:openastronomy.org`: https://chat.openastronomy.org/#/room/#sunpy:openastronomy.org
.. _issues page: https://github.com/sunpy/sunpy/issues
.. _Newcomers' guide: https://docs.sunpy.org/en/latest/dev_guide/newcomers.html

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

When you are interacting with the SunPy community you are asked to follow our `Code of Conduct`_.

.. _Code of Conduct: https://docs.sunpy.org/en/latest/code_of_conduct.html


