stixpy 0.3.0

An open-source Python analysis library for the Spectrometer Telescope for Imaging X-rays (STIX) instrument on Solar Obriter.

An open-source Python analysis library for the Spectrometer Telescope for Imaging X-rays (STIX) instrument on Solar Obriter.

Installation

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

pip install stixpy

To install the developer version and set up a development environment, follow the instructions in our Developers Guide

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.

Acknowledging or Citing STIXpy

If you use STIXpy in your scientific work, we would appreciate your citing it in your publications. The continued growth and development of STIXPy is dependent on the community being aware of STIXpy.

Contributing

We love contributions! STIXpy 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. 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.

When you are interacting with the SunPy community you are asked at to follow our code of conduct.