Metadata-Version: 2.4
Name: desispec
Version: 0.70.0
Summary: DESI Spectroscopic Tools
Home-page: https://github.com/desihub/desispec
Author: DESI Collaboration
Author-email: desi-data@desi.lbl.gov
License: BSD-3-Clause
Requires-Python: >=3.10
Description-Content-Type: text/x-rst
License-File: LICENSE.rst
Requires-Dist: pytz
Requires-Dist: requests
Requires-Dist: astropy
Requires-Dist: scipy
Requires-Dist: fitsio
Requires-Dist: numba
Requires-Dist: healpy
Requires-Dist: speclite
Requires-Dist: sqlalchemy
Requires-Dist: desiutil
Requires-Dist: desitarget
Requires-Dist: desimodel
Provides-Extra: all
Provides-Extra: test
Requires-Dist: pytest; extra == "test"
Provides-Extra: coverage
Requires-Dist: pytest-cov; extra == "coverage"
Requires-Dist: coveralls; extra == "coverage"
Provides-Extra: doc
Requires-Dist: Sphinx; extra == "doc"
Requires-Dist: sphinx-rtd-theme; extra == "doc"
Dynamic: license-file

========
desispec
========

|Actions Status| |Coveralls Status| |Documentation Status|

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

.. |Coveralls Status| image:: https://coveralls.io/repos/desihub/desispec/badge.svg
    :target: https://coveralls.io/github/desihub/desispec
    :alt: Test Coverage Status

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

Introduction
------------

This package contains scripts and packages for building and running DESI spectroscopic analyses.
Details about the algorithms are documented in `Guy et al 2023 AJ 165 144G <https://ui.adsabs.harvard.edu/abs/2023AJ....165..144G/abstract>`_.


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

You can install these tools in a variety of ways.  Here are several that may be of interest:

1.  Manually running from the git checkout.  Add the "bin" directory to your $PATH environment variable and add the "py" directory to your $PYTHONPATH environment variable.
2.  Install (and uninstall) a symlink to your live git checkout::

        $>  python setup.py develop --prefix=/path/to/somewhere
        $>  python setup.py develop --prefix=/path/to/somewhere --uninstall

3.  Install a fixed version of the tools::

        $>  python setup.py install --prefix=/path/to/somewhere


Versioning
----------

If you have tagged a version and wish to set the package version based on your current git location::

    $>  python setup.py version

And then install as usual.

Full Documentation
------------------

Please visit `desispec on Read the Docs`_

.. _`desispec on Read the Docs`: https://desispec.readthedocs.io/en/latest/


License
-------

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