Skip to content

Commit e176e5e

Browse files
committed
[MINOR] Update docs with pip instructions, publications
1 parent 7291766 commit e176e5e

File tree

4 files changed

+35
-50
lines changed

4 files changed

+35
-50
lines changed

docs/source/index.rst

Lines changed: 4 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -32,28 +32,15 @@ Quickstart
3232
----------
3333
Installation
3434
^^^^^^^^^^^^
35-
Complete installation instructions and common troubleshooting tips can be found
36-
:doc:`here <install>`. To install BSK-RL:
37-
38-
#. Install the `Basilisk <https://hanspeterschaub.info/basilisk>`_ spacecraft simulation
39-
framework.
40-
#. Clone BSK-RL.
35+
BSK-RL is available on PyPi and can be installed with pip. Simply run
4136

4237
.. code-block:: console
4338
44-
$ git clone git@github.com:AVSLab/bsk_rl.git && cd bsk_rl
45-
46-
#. Install BSK-RL in the same virtual environment as Basilisk.
47-
48-
.. code-block:: console
39+
$ pip install bsk-rl
4940
50-
(.venv) $ python -m pip install -e .
51-
52-
#. Test the installation.
53-
54-
.. code-block:: console
41+
Complete installation instructions for an editable installation and common troubleshooting tips can be found
42+
:doc:`here <install>`.
5543

56-
(.venv) $ pytest .
5744

5845
Construct an Environment
5946
^^^^^^^^^^^^^^^^^^^^^^^^

docs/source/install.rst

Lines changed: 23 additions & 27 deletions
Original file line numberDiff line numberDiff line change
@@ -5,18 +5,34 @@ Installation
55
:maxdepth: 1
66

77

8-
Instructions
9-
------------
8+
Quick Installation
9+
------------------
10+
BSK-RL is available on PyPi and can be installed with pip. Simply run
11+
12+
.. code-block:: console
13+
14+
$ pip install bsk-rl
15+
16+
17+
Editable Installation
18+
---------------------
1019
#. Install the `Basilisk <http://hanspeterschaub.info/basilisk/Install.html>`_ spacecraft
11-
simulation framework, following instructions for the appropriate operating system.
12-
Installation on MacOS and Linux is preferable to Windows. Use a Python virtual
13-
environment as suggested in the Basilisk installation instructions.
14-
#. Clone the BSK-RL repository.
20+
simulation framework, either with `pip install bsk` or by following instructions for
21+
the appropriate operating system. Installation on MacOS and Linux are preferable to
22+
Windows. Use a Python virtual environment as suggested in the Basilisk installation
23+
instructions.
24+
#. Clone the BSK-RL repository over SSH:
1525

1626
.. code-block:: console
1727
1828
$ git clone git@github.com:AVSLab/bsk_rl.git
1929
30+
or over HTTPS, as some networks block SSH:
31+
32+
.. code-block:: console
33+
34+
$ git clone https://github.com/AVSLab/bsk_rl.git
35+
2036
#. Move to the base directory of the repository.
2137

2238
.. code-block:: console
@@ -58,24 +74,4 @@ Instructions
5874
Common Issues
5975
-------------
6076

61-
Please report new installation issues on GitHub.
62-
63-
SPICE Errors
64-
^^^^^^^^^^^^
65-
66-
Errors such as
67-
68-
.. code-block:: console
69-
70-
Toolkit version: N0065
71-
72-
SPICE(NOSUCHFILE) --
73-
74-
The attempt to load
75-
"/home/user/basilisk/dist3/Basilisk/supportData/EphemerisData/de430.bsp" by
76-
the routine FURNSH failed. It could not be located.
77-
78-
A traceback follows. The name of the highest level module is first.
79-
furnsh_c --> FURNSH --> ZZLDKER
80-
81-
can be resolved by ensuring that `Basilisk is installed using git-lfs <http://hanspeterschaub.info/basilisk/Install/pullCloneBSK.html>`_.
77+
Please report new installation issues on GitHub.

docs/source/publications.rst

Lines changed: 7 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,9 +38,11 @@ Conference Papers
3838
#. \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.
3939
#. \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.
4040
#. \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.
41-
#. \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.
41+
#. \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.
4242
#. \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.
43-
#. \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.
44-
#. \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.
45-
#. \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.
46-
#. \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.
43+
#. \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.
44+
#. \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.
45+
#. \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.
46+
#. \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.
47+
#. \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.
48+
#. \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.

pyproject.toml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,8 +6,8 @@ build-backend = "setuptools.build_meta"
66
name = "bsk_rl"
77
version = "1.2.5"
88
authors = [
9-
{ name = "Adam Herrmann", email = "adam.herrmann@colorado.edu" },
109
{ name = "Mark Stephenson", email = "mark.a.stephenson@colorado.edu" },
10+
{ name = "Adam Herrmann", email = "adam.herrmann@colorado.edu" },
1111
]
1212
description = "RL environments and tools for spacecraft autonomy research, built on Basilisk. Developed by the AVS Lab."
1313
readme = "README.md"

0 commit comments

Comments
 (0)