desihub / desibgs

Code and documentation pertaining to the DESI Bright Galaxy Survey (BGS).

desibgs

Introduction

This repository contains code and documentation for the DESI Bright Galaxy Survey (BGS). For full documentation please visit desibgs on Read the Docs.

Installation

This product is installable using pip or it can cloned directly from Github. For example, to install the "0.1.0" tag (or release) do

pip install git+https://github.com/desihub/[email protected]

Alternatively, you can clone the master branch from Github

git clone [email protected]:desihub/desibgs.git

and then either install the package to an installation directory of your choice

python setup.py install --prefix=$INSTALL_DIR

or explicitly add the code directory to your $PYTHONPATH environment, e.g.

export PYTHONPATH=/path/to/desibgs/py:$PYTHONPATH
export PATH=/path/to/desibgs/bin:${PATH}

Product Contents

bin/

Executable scripts.

doc/

High-level documentation (.rst files).

etc/

Small data and configuration files.

py/

Python code.

License

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