Installation

Install Python 3

The FOBOS Producer is supported for Python 3 only. To install Python, you can do so along with a full package manager, like Anaconda, or you can install python 3 directly from python.org.

Python environment

We strongly recommend you setup a fresh python environment for installation and use of the FOBOS producer. See, for example:

Clone the repo

To download the software and associated data, clone the GitHub repo by executing:

git clone https://github.com/Keck-FOBOS/producer.git

This will create a new producer directory in the directory where the command is executed.

Install from source

The preferred method to install producer and ensure its dependencies are met is to, from the top-level directory, run:

pip install -e .

Importantly, note that this will upgrade/install FOBOS producer python package dependencies, which is why it’s useful to isolate the code to its own environment. To include the development dependencies, run:

pip install -e ".[dev]"

Note that use of the quotes is shell dependent; e.g., you need them for zshell (the current default Mac shell), but they’ll cause a fault in bash.

Installation in this way should also means that changes made to the code should take effect immediately when re-running code.

Uninstall

Installation via pip is preferred because it eases uninstalling the code:

pip uninstall fobos-producer

Test your installation

If you’ve installed with the developer dependencies, you can test the installation using pytest:

cd producer/tests
pytest . -W ignore

Problems?

If you have problems, particularly those that you think may be a more general problem, please Submit an issue.