speclite

Lightweight utilities for working with spectroscopic data

https://github.com/desihub/speclite

Keywords

Repository

Lightweight utilities for working with spectroscopic data

README.rst

================
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 `_ | `stable `_
* Based on the Astropy affiliated package template.

Citation
--------

|DOI|

Please cite as:

David Kirkby, *et al.*. (2024).
desihub/speclite: Bug fix release: General clean-up prior to refactoring package infrastructure (v0.20). Zenodo. https://doi.org/10.5281/zenodo.13225530

See also the file `CITATION.cff`.

Requirements
------------

Speclite has the following package requirements:

* `NumPy `__
* `SciPy `__
* `Matplotlib `__
* `Astropy `__
* `PyYAML `__

License
-------

speclite is free software licensed under a 3-clause BSD-style license. For details see
the ``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. Check in the changes; a ``git push`` is optional at this point.
3. 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.
4. Update ``docs/changes.rst``: add a new entry for a future tag with ``(unreleased)``.
5. Check in the changes, then push: ``git push; git push --tags``.
6. In your git clone, check out the tag: ``git co vX.Y.Z``.
7. Run ``python -m build``. This will create tar and wheel files in the ``dist/`` directory.
8. In the ``dist/`` directory, inspect the ``.tar.gz`` file. Make sure the version is set properly, that all expected files are present, etc.
9. In the ``dist/`` directory, run ``python -m twine upload *.gz *.whl``.
10. In your git clone, clean up and go back to ``main``.  You don't want to accidentally edit or commit on a tag.
11. 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.
12. On the ``main`` branch, update the ``README.rst`` file (this file), and the ``CITATION.cff`` file with the new DOI.

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

.. |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

Owner

Citation (CITATION.cff)

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
  - family-names: Kirkby
    given-names: David
    orcid: "https://orcid.org/0000-0002-8828-5463"
  - family-names: Robitaille
    given-names: "Thomas P."
    orcid: "https://orcid.org/0000-0002-8642-1329"
  - family-names: Weaver
    given-names: "Benjamin Alan"
    orcid: ""
  - family-names: Moustakas
    given-names: John
    orcid: "https://orcid.org/0000-0002-2733-4559"
  - family-names: Tollerud
    given-names: Erik
    orcid: "https://orcid.org/0000-0002-9599-310X"
  - family-names: Droettboom
    given-names: Michael
    orcid: ""
  - family-names: Sipőcz
    given-names: "Brigitta M."
    orcid: "https://orcid.org/0000-0002-3713-6337"
  - family-names: Bray
    given-names: "E. M."
    orcid: ""
  - family-names: Bradley
    given-names: Larry
    orcid: "https://orcid.org/0000-0002-7908-9284"
  - family-names: Park
    given-names: Andy
    orcid: ""
  - family-names: Burgess
    given-names: "J. Michael"
    orcid: "https://orcid.org/0000-0003-3345-9515"
  - family-names: Alvarez
    given-names: Marcelo
    orcid: ""
  - family-names: Bailey
    given-names: Stephen
    orcid: "https://orcid.org/0000-0003-4162-6619"
  - family-names: Koposov
    given-names: Sergei
    orcid: "https://orcid.org/0000-0003-2644-135X"
  - family-names: Lang
    given-names: Dustin
    orcid: "https://orcid.org/0000-0002-1172-0754"
  - family-names: Craig
    given-names: "Matthew W."
    orcid: "https://orcid.org/0000-0001-7988-8919"
  - family-names: Deil
    given-names: Christoph
    orcid: ""
  - family-names: Lim
    given-names: "P. L."
    orcid: "https://orcid.org/0000-0003-0079-4114"
  - family-names: Barbary
    given-names: Kyle
    orcid: "https://orcid.org/0000-0002-2532-3696"
  - family-names: Ginsburg
    given-names: Adam
    orcid: "https://orcid.org/0000-0001-6431-9633"
  - family-names: Kerzendorf
    given-names: Wolfgang
    orcid: "https://orcid.org/0000-0002-0479-7235"
  - family-names: dcunning11235
    given-names: ""
    orcid: ""
  - family-names: "du Mas des Bourboux"
    given-names: Hélion
    orcid: ""
  - family-names: Crawford
    given-names: Steve
    orcid: "https://orcid.org/0000-0002-8969-5229"
  - family-names: Zabalza
    given-names: Víctor
    orcid: "https://orcid.org/0000-0003-2638-7648"
  - family-names: "Sánchez Utgés"
    given-names: Javier
    orcid: "https://orcid.org/0000-0002-1078-1440"
  - family-names: Günther
    given-names: "Hans Moritz"
    orcid: "https://orcid.org/0000-0003-4243-2840"
title: "desihub/speclite: Bug fix release: General clean-up prior to refactoring package infrastructure"
version: v0.20
doi: 10.5281/zenodo.13225530
date-released: "2024-08-05"
repository-code: "https://github.com/desihub/speclite"
license: BSD-3-Clause
identifiers:
  - description: "Version v0.20 of speclite"
    type: doi
    value: 10.5281/zenodo.13225530
  - description: "Version v0.19 of speclite"
    type: doi
    value: 10.5281/zenodo.11095134
  - description: "Version v0.18 of speclite"
    type: doi
    value: 10.5281/zenodo.10520287
  - description: "Version v0.17 of speclite"
    type: doi
    value: 10.5281/zenodo.8347108
  - description: "Version v0.16 of speclite"
    type: doi
    value: 10.5281/zenodo.7734526
  - description: "All versions of speclite"
    type: doi
    value: 10.5281/zenodo.7734525

GitHub Events

Issues and Pull Requests

Last synced: 7 months ago