Metadata-Version: 2.4
Name: dkist
Version: 1.17.0
Summary: DKIST User Tools
Author-email: NSO / AURA <stuart@cadair.com>
Project-URL: Homepage, https://github.com/DKISTDC/dkist
Project-URL: Source Code, https://github.com/DKISTDC/dkist
Project-URL: Download, https://pypi.org/project/dkist
Project-URL: Documentation, https://docs.dkist.nso.edu/projects/python-tools/en/stable/
Project-URL: Changelog, https://docs.dkist.nso.edu/projects/python-tools/en/stable/whatsnew/changelog.html
Project-URL: Issue Tracker, https://github.com/DKISTDC/dkist/issues
Requires-Python: >=3.11
Description-Content-Type: text/x-rst
Requires-Dist: aiohttp>=3.9
Requires-Dist: asdf>=3.3.0
Requires-Dist: asdf-astropy>=0.5.0
Requires-Dist: asdf-coordinates-schemas>=0.3.0
Requires-Dist: asdf-standard>=1.1.0
Requires-Dist: asdf-transform-schemas>=0.6.0
Requires-Dist: asdf-wcs-schemas>=0.4.0
Requires-Dist: astropy>=6.1
Requires-Dist: dask[array]>=2024.4.1
Requires-Dist: globus-sdk>=4.0
Requires-Dist: gwcs>=0.24.0
Requires-Dist: matplotlib>=3.9
Requires-Dist: ndcube[plotting,reproject]>=2.4.0
Requires-Dist: numpy>=1.26
Requires-Dist: parfive[ftp]>=2.2.0
Requires-Dist: platformdirs>=4.5
Requires-Dist: packaging>=25.0
Requires-Dist: sunpy[asdf,net]>=5.0.7
Requires-Dist: tqdm>=4.65
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-asdf-plugin; extra == "tests"
Requires-Dist: pytest-doctestplus; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: pytest-remotedata; extra == "tests"
Requires-Dist: pytest-mock; extra == "tests"
Requires-Dist: pytest-mpl; extra == "tests"
Requires-Dist: pytest-httpserver; extra == "tests"
Requires-Dist: pytest-filter-subpackage; extra == "tests"
Requires-Dist: pytest-benchmark; extra == "tests"
Requires-Dist: pytest-xdist; extra == "tests"
Requires-Dist: pytest-lazy-fixtures; extra == "tests"
Requires-Dist: hypothesis; extra == "tests"
Requires-Dist: tox; extra == "tests"
Requires-Dist: pydot; extra == "tests"
Provides-Extra: docs
Requires-Dist: sphinx<9; extra == "docs"
Requires-Dist: sphinx-automodapi; extra == "docs"
Requires-Dist: sphinx-changelog; extra == "docs"
Requires-Dist: sunpy-sphinx-theme; extra == "docs"
Requires-Dist: sphinx-astropy; extra == "docs"
Requires-Dist: sphinx-gallery; extra == "docs"
Requires-Dist: pytest; extra == "docs"
Requires-Dist: sphinx_autodoc_typehints; extra == "docs"
Requires-Dist: dkist-sphinx-theme>=2.0; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: myst-nb; extra == "docs"
Requires-Dist: ipywidgets; extra == "docs"
Requires-Dist: accessible-pygments; extra == "docs"
Requires-Dist: reproject[all]; extra == "docs"
Requires-Dist: sunpy[asdf,net]>=6.1.0; extra == "docs"
Requires-Dist: snowballstemmer<3; extra == "docs"
Requires-Dist: distributed; extra == "docs"

DKIST User Tools
================

.. image:: https://img.shields.io/pypi/v/dkist.svg
   :target: https://pypi.python.org/pypi/dkist/
   :alt: PyPI for dkist package
.. image:: https://img.shields.io/pypi/pyversions/dkist
   :alt: PyPI - Python Version
.. image:: https://img.shields.io/matrix/dki-solar-telescope:openastronomy.org.svg?colorB=%23FE7900&label=Chat&logo=matrix&server_fqdn=matrix.org
   :target: https://app.element.io/#/room/#dki-solar-telescope:openastronomy.org
   :alt: DKIST chat room on matrix
.. image:: https://github.com/DKISTDC/dkist/actions/workflows/main.yml/badge.svg?branch=main
   :target: https://github.com/DKISTDC/dkist/actions/workflows/main.yml
   :alt: Latest CI Status for dkist package
.. image:: https://codecov.io/github/dkistdc/dkist/branch/master/graph/badge.svg?token=A4ggaCurqz
   :target: https://codecov.io/github/dkistdc/dkist
   :alt: Latest codecov Status for dkist package
.. image:: https://readthedocs.com/projects/dkistdc-dkist/badge/?version=latest
   :target: https://docs.dkist.nso.edu/projects/python-tools
   :alt: Documentation Status
.. image:: http://img.shields.io/badge/powered%20by-SunPy-orange.svg?style=flat
   :target: http://www.sunpy.org
   :alt: Powered by SunPy Badge

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 <https://docs.dkist.nso.edu/projects/python-tools>`__.

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

The recommended way to install ``dkist`` is with `miniforge <https://github.com/conda-forge/miniforge#miniforge3>`__.
To install ``dkist`` once miniforge is installed run the following command:

.. code:: bash

    $ conda install dkist

For detailed installation instructions, see the `installation guide <https://docs.dkist.nso.edu/projects/python-tools/en/stable/installation.html>`__ 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 <https://sunpy.org/coc>`__.

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 <https://github.com/DKISTDC/dkist/actions/workflows/prepare-release.yml>`__.
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 <https://github.com/DKISTDC/dkist/releases>`__, once the PR is merged you can publish that release, this will trigger the rest as long as the CI passes.
