diff --git a/docs/source/index.rst b/docs/source/index.rst index b0eedf4f..991e72d2 100644 --- a/docs/source/index.rst +++ b/docs/source/index.rst @@ -32,28 +32,15 @@ Quickstart ---------- Installation ^^^^^^^^^^^^ -Complete installation instructions and common troubleshooting tips can be found -:doc:`here `. To install BSK-RL: - -#. Install the `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 `. - (.venv) $ pytest . Construct an Environment ^^^^^^^^^^^^^^^^^^^^^^^^ diff --git a/docs/source/install.rst b/docs/source/install.rst index d8b99b36..c52f06dd 100644 --- a/docs/source/install.rst +++ b/docs/source/install.rst @@ -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 `_ 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 @@ -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 `_. +Please report new installation issues on GitHub. \ No newline at end of file diff --git a/docs/source/publications.rst b/docs/source/publications.rst index d80988fd..f0fcf4d1 100644 --- a/docs/source/publications.rst +++ b/docs/source/publications.rst @@ -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,” `_ 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,” `_ 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,” `_ 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,” `_ 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,” `_ 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. \ No newline at end of file +#. \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,” `_ arXiv preprint, June 2025. +#. \C. Whitney and J. Melville, `“Toward Trusted Onboard AI: Advancing Small Satellite Operations using Reinforcement Learning,” `_ 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,” `_ 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. \ No newline at end of file diff --git a/pyproject.toml b/pyproject.toml index 3b4db056..96697e9b 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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"