README

Basilisk

• Summary of Basilisk
• Release Notes

Installation

Basilisk can be installed in two ways, either from PyPI or by building from source.

For most users, installing from PyPI is the easiest and fastest way to get started. Building from source is recommended if you need to link to external C++ modules or want to customize the build configuration.

Install from PyPI

The easiest way to get started with Basilisk is to install the prebuilt wheel from PyPI:

pip install "bsk[all]"

This installs the latest stable version with the core Basilisk wheel and all optional Basilisk component wheels. MuJoCo is included in the core wheel, while optical navigation is installed through the optional component package. See the install docs for supported platforms and additional details about the wheels.

If you need a smaller installation and do not use optional Basilisk components, install only the core wheel:

pip install bsk

If you also want the optional Python dependencies used by example scripts, install:

pip install "bsk[all,examples]"

Build from Source

If you need to use external C++ modules or want to customize the build, follow the platform-specific setup instructions:

• Setup a macOS Development Environment

• Setup a Linux Development Environment

• Setup a Windows Development Environment

See the Build from Source docs for full details.

Containers

Basilisk container images are published to:

• GHCR

Published tags follow this policy:

• v* (for example v2.9.0) and latest for release tags

Images are multi-architecture (linux/amd64, linux/arm64).

Quick start:

docker pull ghcr.io/avslab/basilisk:latest
docker run --rm ghcr.io/avslab/basilisk:latest

For more details, see container docs.

Basilisk Development guidelines

• Contributing
• Coding Guidelines

Getting Started

To get started with Basilisk (BSK), several tutorial python files are provided in the installed package. Within this web page documentation site, they are listed and discussed in the integrated example script page.

The documentation lists the scenarios in an order that facilitates learning basic BSK features. The python scripts are stored in the repository under basilisk/examples. A good start would be to run scenarioBasicOrbit.py.

If you downloaded Basilisk through pip install "bsk[all]", then you can download all examples to the local folder using the command line bskExamples.

To play with the tutorials, it is suggested the user makes a copy of these tutorial files, and use the copies in order to learn, test and experiment. Copy the folder basilisk/examples into a new folder, and change to that directory. To run the default scenario of scenarioBasicOrbit, in the directory of the copied tutorials, execute the python script: python scenarioBasicOrbit.py

Now, when you want to use a tutorial, navigate inside that folder, and edit and execute the copied integrated tests.

Any new BSK module development should not occur within the BSK folder as this will be updated rapidly. Rather, new FSW algorithm or simulation code modules should be created in a custom folder outside of the BSK directory. See the building custom modules web page for more information.

To use the standalone 3D Visualization, download the Vizard. This is in development, but does provide a 3D view of many of the simulation states.

Who do I talk to?

Questions and answers are fielded in the project's Github Discussions.