Installation

Quick Installation

BSK-RL is available on PyPi and can be installed with pip. Simply run

$ pip install bsk-rl

Editable Installation

1. Install the Basilisk spacecraft simulation framework, either with pip install bsk or by following instructions for the appropriate operating system. Installation on MacOS and Linux are preferable to Windows. Use a Python virtual environment as suggested in the Basilisk installation instructions.

2. Clone the BSK-RL repository over SSH:

   $ git clone git@github.com:AVSLab/bsk_rl.git
   

   or over HTTPS, as some networks block SSH:

   $ git clone https://github.com/AVSLab/bsk_rl.git
   

3. Move to the base directory of the repository.

   $ cd bsk_rl
   

4. Ensure that the virtual environment Basilisk is installed in is active. Install BSK-RL with the following command.

   (.venv) $ python -m pip install -e "."
   

   The first half of this command will install pip dependencies and an editable copy of the BSK-RL package.

   For a more granular installation, .[docs] (for documentation dependencies) or .[rllib] (for RLlib tools) can be specified. .[all] installs all dependencies.

5. Test the installation by running the unit tests and integration tests.

   (.venv) $ pytest tests/unittest
   (.venv) $ pytest tests/integration
   

   The installation can also be verified by running Examples from the examples directory.

6. To build documentation locally, run:

   (.venv) $ cd docs
   (.venv) $ make html
   (.venv) $ make view
   

Common Issues

Please report new installation issues on GitHub.