Installation

Python Versions

Managing python versions

Subaru’s archive interface depends on python 2, while this package requires at least python 3.10. You will inevitably need to manage different python versions. I recommend using pyenv or conda

Using pip

For now, install directly from GitHub

pip install -U git+https://github.com/scexao-org/vampires_dpp.git

From Source

The source code for vampires_dpp can be downloaded and installed from GitHub by running

git clone https://github.com/scexao-org/vampires_dpp
cd vampires_dpp
pip install -e .

Testing

You can quickly check if you’ve installed the pipeline correctly by calling the dpp command

dpp --version

To run the unit tests, install the development dependencies using pip:

pip install -e ".[test]"

and then execute:

pytest

This will automatically run the tests with plugins enabled. All of the tests should (of course) pass. If any of the tests don’t pass and if you can’t sort out why, open an issue on GitHub.

Contributing

If you would like to contribute, first off, thank you! To get started, you should install our git pre-commit hooks which autoformat the repository. After you have pre-commit installed, run

cd vampires_dpp
pip install -e ".[dev]"
pre-commit install

and you’re all set! Now whenever you git commit the source files will be linted and formatted using ruff. Any linting errors that cannot be auto-fixed will disallow git commit unless overridden (git commit -n).

Any contributions should be submitted as pull requests. Feel free to reach out ahead of time about questions or ambitions about contributing.

Documentation

To build these docs locally, first install the documentation dependencies

pip install -e ".[docs]"

Then, run the sphinx make script

sphinx-build docs docs/_build

Local docs viewer

To quickly serve the generated HTML files you can use

python -m http.server -d docs/_build/html 8000

(or any port you’d like) and view them in an internet browser at the url localhost:8000/index.html