Installation¶
Quick Installation¶
Installation from PyPI:
pip install rubin-scheduler
scheduler_download_data
or from conda-forge:
conda install -c conda-forge rubin-scheduler
scheduler_download_data
The scheduler_download_data
command downloads additional data
to the default directory rubin_sim_data
. If you would prefer
the data go elsewhere, see the instructions at
Data Download.
For Developer Use¶
First, clone the rubin_scheduler repository:
git clone git@github.com:lsst/rubin_scheduler.git
cd rubin_scheduler
conda create --channel conda-forge --name rubin_scheduler --file requirements.txt python=3.12
conda activate rubin_scheduler
conda install -c conda-forge --file=test-requirements.txt # Optional for running unit tests
pip install -e . --no-deps
scheduler_download_data
The scheduler_download_data
command downloads additional data
to the default directory rubin_sim_data
. If you would prefer
the data go elsewhere, see the instructions at
Data Download.
Note that if you install other packages, such as rubin_sim, you
may need to uninstall conda versions of rubin_scheduler and
re-run the pip install -e . --no-deps
command.
Building Documentation¶
An online copy of the documentation is available at https://rubin-scheduler.lsst.io, however building a local copy can be done as follows:
pip install "documenteer[guide]"
cd docs
make html
The root of the local documentation will then be docs/_build/html/index.html
.