Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 4 additions & 17 deletions docs/source/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -32,28 +32,15 @@ Quickstart
----------
Installation
^^^^^^^^^^^^
Complete installation instructions and common troubleshooting tips can be found
:doc:`here <install>`. To install BSK-RL:

#. Install the `Basilisk <https://hanspeterschaub.info/basilisk>`_ spacecraft simulation
framework.
#. Clone BSK-RL.
BSK-RL is available on PyPi and can be installed with pip. Simply run

.. code-block:: console

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

#. Install BSK-RL in the same virtual environment as Basilisk.

.. code-block:: console
$ pip install bsk-rl

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

#. Test the installation.

.. code-block:: console
Complete installation instructions for an editable installation and common troubleshooting tips can be found
:doc:`here <install>`.

(.venv) $ pytest .

Construct an Environment
^^^^^^^^^^^^^^^^^^^^^^^^
Expand Down
50 changes: 23 additions & 27 deletions docs/source/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -5,18 +5,34 @@ Installation
:maxdepth: 1


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

.. code-block:: console
$ pip install bsk-rl
Editable Installation
---------------------
#. Install the `Basilisk <http://hanspeterschaub.info/basilisk/Install.html>`_ spacecraft
simulation framework, following instructions for the appropriate operating system.
Installation on MacOS and Linux is preferable to Windows. Use a Python virtual
environment as suggested in the Basilisk installation instructions.
#. Clone the BSK-RL repository.
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.
#. Clone the BSK-RL repository over SSH:

.. code-block:: console
$ git clone git@github.com:AVSLab/bsk_rl.git
or over HTTPS, as some networks block SSH:

.. code-block:: console
$ git clone https://github.com/AVSLab/bsk_rl.git
#. Move to the base directory of the repository.

.. code-block:: console
Expand Down Expand Up @@ -58,24 +74,4 @@ Instructions
Common Issues
-------------

Please report new installation issues on GitHub.

SPICE Errors
^^^^^^^^^^^^

Errors such as

.. code-block:: console
Toolkit version: N0065
SPICE(NOSUCHFILE) --
The attempt to load
"/home/user/basilisk/dist3/Basilisk/supportData/EphemerisData/de430.bsp" by
the routine FURNSH failed. It could not be located.
A traceback follows. The name of the highest level module is first.
furnsh_c --> FURNSH --> ZZLDKER
can be resolved by ensuring that `Basilisk is installed using git-lfs <http://hanspeterschaub.info/basilisk/Install/pullCloneBSK.html>`_.
Please report new installation issues on GitHub.
12 changes: 7 additions & 5 deletions docs/source/publications.rst
Original file line number Diff line number Diff line change
Expand Up @@ -38,9 +38,11 @@ Conference Papers
#. \M. Stephenson, L. Quevedo Mantovani, A. Cheval and H. Schaub, `“Quantifying The Optimality Of A Distributed Rl-Based Autonomous Earth-Observing Constellation,” <https://hanspeterschaub.info/Papers/Stephenson2025.pdf>`_ AAS Guidance, Navigation and Control Conference, Breckenridge, CO, January 31 – February 5, 2025.
#. \L. Quevedo Mantovani and H. Schaub, `“Improving Robustness Of Autonomous Spacecraft Scheduling Using Curriculum Learning,” <https://hanspeterschaub.info/Papers/QuevedoMantovani2025.pdf>`_ AAS Guidance, Navigation and Control Conference, Breckenridge, CO, January 31 – February 5, 2025.
#. \M. Stephenson, D. Huterer Prats and H. Schaub, `“Autonomous Satellite Inspection in Low Earth Orbit with Optimization-Based Safety Guarantees,” <https://hanspeterschaub.info/Papers/Stephenson2025a.pdf>`_ International Workshop on Planning & Scheduling for Space, Toulouse, France, April 28–30, 2025.
#. \M. Stephenson, L. Quevedo Mantovani and H. Schaub, “Achieving Near-Optimal Performance in Autonomous Earth Observing Satellite Scheduling using semi-MDPs,” International Workshop on Planning & Scheduling for Space, Toulouse, France, April 28–30, 2025.
#. \M. Stephenson, L. Quevedo Mantovani and H. Schaub, `“Achieving Near-Optimal Performance in Autonomous Earth Observing Satellite Scheduling using semi-MDPs,” <https://hanspeterschaub.info/Papers/Stephenson2025c.pdf>`_ International Workshop on Planning & Scheduling for Space, Toulouse, France, April 28–30, 2025.
#. \L. Quevedo Mantovani and H. Schaub, `“Performance Evaluation of Shielded Neural Networks for Autonomous Agile Earth Observing Satellites in Long Term Scenarios,” <https://hanspeterschaub.info/Papers/QuevedoMantovani2025a.pdf>`_ International Workshop on Planning & Scheduling for Space, Toulouse, France, April 28–30, 2025.
#. \A. Cheval and H. Schaub, “Reinforcement Learning For Autonomous Strip Imaging Task Scheduling In Super-Agile Satellites,” AAS Astrodynamics Specialist Conference, Boston, Massachusetts, August 10–14, 2025.
#. \Y. Nagano and H. Schaub, “Enhancing Fault Resilience In {RL}-Based Satellite Autonomous Task Scheduling,” AAS Astrodynamics Specialist Conference, Boston, Massachusetts, August 10–14, 2025.
#. \D. Huterer Prats and H. Schaub, “Reinforcement Learning for Space-to-Space Surveillance: Autonomous Scheduling for Resident Space Object Imaging,” Advanced Maui Optical and Space Surveillance Technologies Conference, Maui, Hawaii, September 16–19, 2025.
#. \M. Stephenson and H. Schaub, “Safe, Autonomous Multiagent Inspection of Space Objects Leveraging Relative Orbit Dynamics,” Advanced Maui Optical and Space Surveillance Technologies Conference, Maui, Hawaii, September 16–19, 2025.
#. \M. A. Hady, S. Hu, M. Pratama, J. Cao, and R. Kowalczyk, `“Multi-Agent Reinforcement Learning for Autonomous Multi-Satellite Earth Observation: A Realistic Case Study,” <https://arxiv.org/abs/2506.15207>`_ arXiv preprint, June 2025.
#. \C. Whitney and J. Melville, `“Toward Trusted Onboard AI: Advancing Small Satellite Operations using Reinforcement Learning,” <https://www.arxiv.org/abs/2507.22198>`_ 39th Small Satellite Conference, Salt Lake City, UT, August 10-13, 2025.
#. \A. Cheval and H. Schaub, `“Reinforcement Learning For Autonomous Strip Imaging Task Scheduling In Super-Agile Satellites,” <https://hanspeterschaub.info/Papers/Cheval2025b.pdf>`_ AAS Astrodynamics Specialist Conference, Boston, Massachusetts, August 10–14, 2025.
#. \Y. Nagano and H. Schaub, `“Enhancing Fault Resilience In {RL}-Based Satellite Autonomous Task Scheduling,” <https://hanspeterschaub.info/Papers/Nagano2025a.pdf>`_ AAS Astrodynamics Specialist Conference, Boston, Massachusetts, August 10–14, 2025.
#. \D. Huterer Prats and H. Schaub, `“Reinforcement Learning for Space-to-Space Surveillance: Autonomous Scheduling for Resident Space Object Imaging,” <https://hanspeterschaub.info/Papers/Prats2025.pdf>`_ Advanced Maui Optical and Space Surveillance Technologies Conference, Maui, Hawaii, September 16–19, 2025.
#. \M. Stephenson and H. Schaub, `“Safe, Autonomous Multiagent Inspection of Space Objects Leveraging Relative Orbit Dynamics,” <https://hanspeterschaub.info/Papers/Stephenson2025b.pdf>`_ Advanced Maui Optical and Space Surveillance Technologies Conference, Maui, Hawaii, September 16–19, 2025.
2 changes: 1 addition & 1 deletion pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ build-backend = "setuptools.build_meta"
name = "bsk_rl"
version = "1.2.5"
authors = [
{ name = "Adam Herrmann", email = "adam.herrmann@colorado.edu" },
{ name = "Mark Stephenson", email = "mark.a.stephenson@colorado.edu" },
{ name = "Adam Herrmann", email = "adam.herrmann@colorado.edu" },
]
description = "RL environments and tools for spacecraft autonomy research, built on Basilisk. Developed by the AVS Lab."
readme = "README.md"
Expand Down