Skip to content

Latest commit

 

History

History
63 lines (39 loc) · 1.94 KB

README.rst

File metadata and controls

63 lines (39 loc) · 1.94 KB
Raw

desispec

GitHub Actions CI Status Test Coverage Status 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.

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

License

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