DKIST User Tools

A Python library of tools for obtaining, processing and interacting with DKIST data.

Documentation

See the documentation at https://docs.dkist.nso.edu/projects/python-tools.

Installation

The recommended way to install dkist is with miniforge. To install dkist once miniforge is installed run the following command:

$ conda install dkist

For detailed installation instructions, see the installation guide in the dkist docs.

License

This project is Copyright (c) NSO / AURA and licensed under the terms of the BSD 3-Clause license.

Code of Conduct

When you are interacting with the dkist project you are asked to follow the SunPy Code of Conduct.

Releasing The dkist package

Doing a release of this package is automated using GitHub actions, the release can be done following these steps:

1. Run the pre-release workflow on GitHub actions, this can be done by clicking "run workflow" here.
2. That workflow will have opened a PR, you should review it and merge it as normal.
3. That workflow will also have drafted a GitHub release here, once the PR is merged you can publish that release, this will trigger the rest as long as the CI passes.