A package for instrument-specific data structures and processing in the SunPy ecosystem.
For detailed installation instructions, see the installation guide in the
This takes you through the options for getting a virtual environment and installing
You will need to replace “sunpy” with “sunkit-instruments”.
Stop by our chat room 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.
If you would like to get involved, please read our contributing guide, this talks about
sunpy but the same is for
If you want help develop
sunkit-instruments you will need to install it from GitHub.
The best way to do this is to create a new python virtual environment.
Once you have that virtual environment, you will want to fork the repo and then run:
$ git clone https://github.com/<your_username>/sunkit-instruments.git
$ cd sunkit-instruments
$ pip install -e ".[dev]"
sunkit-instruments is organised into sub-modules for each instrument:
Note that the code in this package is not maintained by or neccesarily contributed to by instrument teams. Some instruments have individual packages for analysis in Python, including: