Installation from Source

First, clone the Github:

$ git clone https://github.com/Forrest-Fankhauser/lumos-sat.git

Next, create a virtual environment with the necessary packages:

$ python -m venv venv
$ venv/Scripts/activate.bat
(venv) $ pip install -r requirements.txt
(venv) $ pip install -r dev_requirements.txt

Finally, install Lumos in editable mode:

$ cd lumos
$ python -m pip install -e .

Building a Lumos Distribution

First update the Lumos version number in pyproject.toml

To build Lumos, use the following commands:

(.venv) $ python -m build
(.venv) $ twine check dist/*

First check your distribution thoroughly using Test PyPi.

(.venv) $ twine upload -r testpypi dist/*

If that works, you can upload to PyPi

(.venv) $ twine upload dist/*

Building Documentation Locally

(.venv) $ cd docs
(.venv) $ make clean
(.venv) $ make html
(.venv) $ start build/html/index.html