================ speclite package

|Astropy| |PyPI| |License| |Actions Status| |Coveralls Status| |Documentation Status|

Introduction

This package provides a set of lightweight utilities for working with spectroscopic data in astronomy.

• Free software: 3-clause BSD style license.
• Documentation: latest <http://speclite.readthedocs.io/en/latest/> | stable <http://speclite.readthedocs.io/en/stable/>
• Based on the Astropy affiliated package template.

Citation

|DOI|

Please cite as:

David Kirkby, Andy Park, John Moustakas, Stephen Bailey, Benjamin Alan Weaver, Sergey Koposov, Marcelo Alvarez, Hélion du Mas des Bourboux, & Javier Sanchez. (2023). desihub/speclite: 2MASS Filters (v0.17). Zenodo. https://doi.org/10.5281/zenodo.8347108

Requirements

Speclite has the following package requirements:

• NumPy <https://numpy.org/>__
• SciPy <https://scipy.org/>__
• Matplotlib <https://matplotlib.org>__
• Astropy <https://www.astropy.org/>__
• PyYAML <https://pyyaml.org>__

License

speclite is free software licensed under a 3-clause BSD-style license. For details see the licenses/LICENSE.rst file.

Releasing

Please follow these instructions when creating a new tag of speclite.

1. Update docs/changes.rst: set the date corresponding to the next tag.
2. Update setup.cfg: in the [metadata] section set the version entry to the next tag (but without v).
3. Check in the changes; a git push is optional at this point.
4. Create the tag: git tag -s -m 'Tagging speclite/vX.Y.Z' vX.Y.Z. -s is optional; it adds a cryptographic signature to the tag.
5. Update docs/changes.rst: add a new entry for a future tag with (unreleased).
6. Update setup.cfg: set the version entry to the future tag plus .dev.
7. Check in the changes, then push: git push; git push --tags.
8. In your git clone, check out the tag: git co vX.Y.Z.
9. Run python setup.py sdist --format=gztar. This command will change in the future as we move away from using setup.py.
10. In the dist/ directory, inspect the .tar.gz file. Make sure the version is set properly, that all expected files are present, etc.
11. In the dist/ directory, run twine upload speclite-X.Y.Z.tar.gz.
12. In your git clone, clean up and go back to main. You don't want to accidentally edit or commit on a tag.
13. On GitHub, create a new Release corresponding to the tag. This is important: creating a release will also automatically create a new DOI on Zenodo.
14. On the main branch, update the README.rst file (this file) with the new DOI.

.. |DOI| image:: https://zenodo.org/badge/DOI/10.5281/zenodo.8347108.svg :target: https://doi.org/10.5281/zenodo.8347108 :alt: DOI: 10.5281/zenodo.8347108

.. |Astropy| image:: http://img.shields.io/badge/powered%20by-AstroPy-orange.svg?style=flat :target: http://www.astropy.org :alt: Powered by Astropy Badge

.. |License| image:: https://img.shields.io/pypi/l/speclite.svg :target: https://pypi.org/project/speclite/ :alt: BSD License

.. |Actions Status| image:: https://github.com/desihub/speclite/workflows/CI/badge.svg :target: https://github.com/desihub/speclite/actions :alt: GitHub Actions CI Status

.. |Coveralls Status| image:: https://coveralls.io/repos/desihub/speclite/badge.svg?branch=main :target: https://coveralls.io/github/desihub/speclite?branch=main :alt: Test Coverage Status

.. |Documentation Status| image:: https://readthedocs.org/projects/speclite/badge/?version=latest :target: https://speclite.readthedocs.org/en/latest/ :alt: Documentation Status

.. |PyPI| image:: https://img.shields.io/pypi/v/speclite.svg :target: https://pypi.org/project/speclite/ :alt: Distribution Status