Metadata-Version: 2.4
Name: stixpy
Version: 0.2.0
Summary: An open-source Python analysis library for the Spectrometer Telescope for Imaging X-rays (STIX) instrument on Solar Obriter.
Author-email: Shane Maloney <shane.maloney@dias.ie>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://stixpy.readthedocs.io
Project-URL: Source Code, https://github.com/TCDSolar/stixpy
Project-URL: Download, https://pypi.org/project/stixpy
Project-URL: Documentation, https://stixpy.readthedocs.io
Project-URL: Changelog, https://stixpy.readthedocs.io/en/latest/whatsnew/changelog.html
Project-URL: Issue Tracker, https://github.com/TCDSolar/stixpy/issues
Keywords: solar physics,solar,sun,x-rays
Platform: any
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Science/Research
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: Programming Language :: Python :: 3.12
Classifier: Topic :: Scientific/Engineering :: Physics
Provides: stixpy
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
License-File: LICENSE.rst
Requires-Dist: sunpy[map,net,timeseries]>=6.0.0
Requires-Dist: packaging>=23.0
Requires-Dist: reproject
Requires-Dist: astroquery
Requires-Dist: intervaltree
Requires-Dist: roentgen
Requires-Dist: matplotlib
Requires-Dist: xrayvisim~=0.2.0rc
Provides-Extra: tests
Requires-Dist: matplotlib>=3.8.0; extra == "tests"
Requires-Dist: pytest-astropy>=0.11.0; extra == "tests"
Requires-Dist: pytest-mpl>=0.16; extra == "tests"
Requires-Dist: pytest-xdist>=3.0.2; extra == "tests"
Requires-Dist: pytest>=7.1.0; extra == "tests"
Provides-Extra: docs
Requires-Dist: sphinx>=6.0.0; extra == "docs"
Requires-Dist: sphinx-automodapi>=0.14.1; extra == "docs"
Requires-Dist: packaging>=23.0; extra == "docs"
Requires-Dist: sphinx-changelog>=1.5.0; extra == "docs"
Requires-Dist: sphinx-design>=0.2.0; extra == "docs"
Requires-Dist: sphinx-gallery>=0.13.0; extra == "docs"
Requires-Dist: sphinxext-opengraph>=0.6.0; extra == "docs"
Requires-Dist: stixpy[all]; extra == "docs"
Requires-Dist: pydata-sphinx-theme>=0.16.0; extra == "docs"
Provides-Extra: dev
Requires-Dist: stixpy[docs,tests]; extra == "dev"
Dynamic: license-file

stixpy Analysis Software
========================

|Powered By| |Build Status| |Doc Status| |Python Versions|

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

.. |Build Status| image:: https://github.com/TCDSolar/stixpy/actions/workflows/ci.yaml/badge.svg
    :target: https://github.com/TCDSolar/stixpy/actions/workflows/ci.yaml
    :alt: Build Status

.. |Doc Status| image:: https://readthedocs.org/projects/stixpy/badge/?version=stable
    :target: http://stixpy.readthedocs.io/en/latest/?badge=stable
    :alt: Documentation Status

.. |Python Versions| image:: https://img.shields.io/pypi/pyversions/stixpy
    :target: https://pypi.python.org/pypi/stixpy
    :alt: Python Versions

stixpy is an open source Python library for analysis of Spectrometer Telescope for Imaging X-rays (STIX) onboard Solar Orbiter (SO)
data

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

It is strongly advised that you use and isolated environment through python's venv, virturalenv, anaconda or similar.

.. code-block::

   pip install stixpy

To install the developer version and set up a development environment, follow the instructions in our [Developer Guide](https://stixpy.readthedocs.io/en/latest/how_to_guides/dev_guide.html).


Usage
-----

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


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

.. _Code of Conduct: http://docs.sunpy.org/en/stable/coc.html
