Metadata-Version: 2.4
Name: furst-optics
Version: 0.3.0
Summary: A model of the optical design for the Full-sun Ultraviolet Rocket Spectrometer (FURST).
Author-email: "Roy T. Smart" <roytsmart@gmail.com>
License-Expression: BSD-3-Clause
Project-URL: Homepage, https://github.com/Kankelborg-Group/furst-optics
Project-URL: Documentation, https://furst-optics.readthedocs.io/en/latest
Classifier: Programming Language :: Python :: 3
Requires-Python: >=3.12
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: astropy
Requires-Dist: sunpy
Requires-Dist: msfc-ccd<2,>=1.1.1
Requires-Dist: optika~=3.0
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: doc
Requires-Dist: pytest; extra == "doc"
Requires-Dist: matplotlib; extra == "doc"
Requires-Dist: graphviz; extra == "doc"
Requires-Dist: sphinx-autodoc-typehints; extra == "doc"
Requires-Dist: sphinxcontrib-bibtex; extra == "doc"
Requires-Dist: pydata-sphinx-theme; extra == "doc"
Requires-Dist: ipykernel; extra == "doc"
Requires-Dist: jupyter-sphinx; extra == "doc"
Requires-Dist: nbsphinx; extra == "doc"
Requires-Dist: sphinx-favicon; extra == "doc"
Requires-Dist: ussa1976; extra == "doc"
Requires-Dist: pymsis; extra == "doc"
Dynamic: license-file

# furst-optics

[![tests](https://github.com/Kankelborg-Group/furst-optics/actions/workflows/tests.yml/badge.svg)](https://github.com/Kankelborg-Group/furst-optics/actions/workflows/tests.yml)
[![codecov](https://codecov.io/gh/Kankelborg-Group/furst-optics/graph/badge.svg?token=tBcex8q72g)](https://codecov.io/gh/Kankelborg-Group/furst-optics)
[![Black](https://github.com/Kankelborg-Group/furst-optics/actions/workflows/black.yml/badge.svg)](https://github.com/Kankelborg-Group/furst-optics/actions/workflows/black.yml)
[![Ruff](https://github.com/Kankelborg-Group/furst-optics/actions/workflows/ruff.yml/badge.svg)](https://github.com/Kankelborg-Group/furst-optics/actions/workflows/ruff.yml)
[![Documentation Status](https://readthedocs.org/projects/furst-optics/badge/?version=latest)](https://furst-optics.readthedocs.io/en/latest/?badge=latest)
[![PyPI version](https://badge.fury.io/py/furst-optics.svg)](https://badge.fury.io/py/furst-optics)
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.23116748.svg)](https://doi.org/10.5281/zenodo.23116748)

A model of the optical design for the Full-sun Ultraviolet Rocket Spectrometer (FURST).

## Installation Instructions

This package is published on PyPI and can be installed using pip:

```bash
pip install furst-optics
```

## Citation

If you use furst-optics in your research, please cite it.
The citation metadata is kept in [`CITATION.cff`](https://github.com/Kankelborg-Group/furst-optics/blob/main/CITATION.cff),
which the "Cite this repository" button on GitHub can export as BibTeX or APA.

Every release of furst-optics is archived on Zenodo with its own DOI.
The concept DOI, [10.5281/zenodo.23116748](https://doi.org/10.5281/zenodo.23116748),
always resolves to the latest version,
and the Zenodo page lists the DOI of every version.
Please include the version of furst-optics that you used,
which is given by `importlib.metadata.version("furst-optics")`.
The BibTeX entry below uses the concept DOI.
To cite a specific version instead,
replace `doi` with the DOI of that version.

```bibtex
@software{furst-optics,
  author = {Smart, Roy T. and Kankelborg, Charles C.},
  title = {furst-optics},
  version = {X.Y.Z},
  doi = {10.5281/zenodo.23116748},
  url = {https://github.com/Kankelborg-Group/furst-optics},
}
```
