README

Basilisk

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:

See the Build from Source docs for full details.

Containers

Basilisk container images are published to:

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

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.

Project links

Data verified by PyPI on Jul 9, 2026
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (2.11.1)

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for HanspeterSchaub from gravatar.com HanspeterSchaub Avatar for ReeceHumphreys from gravatar.com ReeceHumphreys

GitHub Statistics

Data verified by PyPI on Jul 9, 2026
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License expression

ISC
View SPDX License List

Requires

Python <3.15, >=3.9

Provides Extra

test examples opnav all

Classifiers

Report project as malware

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bsk-2.11.0.tar.gz (29.6 MB view details)

Uploaded Source

Built Distributions

If you're not sure about the file name format, learn more about wheel file names.

bsk-2.11.0-cp39-abi3-win_amd64.whl (66.0 MB view details)

Uploaded CPython 3.9+Windows x86-64

bsk-2.11.0-cp39-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl (86.3 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.27+ x86-64manylinux: glibc 2.28+ x86-64

bsk-2.11.0-cp39-abi3-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl (80.2 MB view details)

Uploaded CPython 3.9+manylinux: glibc 2.27+ ARM64manylinux: glibc 2.28+ ARM64

bsk-2.11.0-cp39-abi3-macosx_11_0_arm64.whl (87.3 MB view details)

Uploaded CPython 3.9+macOS 11.0+ ARM64

File details

Details for the file bsk-2.11.0.tar.gz.

File metadata

  • Download URL: bsk-2.11.0.tar.gz
  • Upload date:
  • Size: 29.6 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bsk-2.11.0.tar.gz
Algorithm Hash digest
SHA256 8422969ff7837f8176a1d62274e846069a9d077bfbf229c20a023ec40c48199e
MD5 25a1b8a55318b4ae0532353b43a0fe40
BLAKE2b-256 27148458ffba17738f9f10fd57726312ce38c59c611d13b970f31e59adc7524d

See more details on using hashes here.

Provenance

The following attestation bundles were made for bsk-2.11.0.tar.gz:

Publisher: publish-wheels.yml on AVSLab/basilisk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bsk-2.11.0-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: bsk-2.11.0-cp39-abi3-win_amd64.whl
  • Upload date:
  • Size: 66.0 MB
  • Tags: CPython 3.9+, Windows x86-64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bsk-2.11.0-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 5558268290474206a1a600c6bbf1847ed02e2c99c10a062e1d98a38076f58eb0
MD5 bd44445c8f6b8141987351088897754f
BLAKE2b-256 f9b811bb1a7cc9ac88f94ae15ba78b3b509b6b8a32a62c42e431a311e91bd078

See more details on using hashes here.

Provenance

The following attestation bundles were made for bsk-2.11.0-cp39-abi3-win_amd64.whl:

Publisher: publish-wheels.yml on AVSLab/basilisk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bsk-2.11.0-cp39-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for bsk-2.11.0-cp39-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 d51fe1ffa1b0b03dc415034b210497b28a2504428d4d8e71b481542a08c08a0a
MD5 a49d2c399f83005ff2970272e44808ee
BLAKE2b-256 80848fedfa36aae20953d6a087cfbfd3fb6da2391b2f6a518ecd2aa29bb8d846

See more details on using hashes here.

Provenance

The following attestation bundles were made for bsk-2.11.0-cp39-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl:

Publisher: publish-wheels.yml on AVSLab/basilisk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bsk-2.11.0-cp39-abi3-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for bsk-2.11.0-cp39-abi3-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 2c7cd6493e6f08e65fa5efe06f177dc97c9aa927cd5cfe4aa679cc32fbf116bd
MD5 4202d24433281f9986493c72aa000d9b
BLAKE2b-256 5822c23346bc090ea76cc718707087ed18e6e091bf9aadb535243b39dc4d8ce6

See more details on using hashes here.

Provenance

The following attestation bundles were made for bsk-2.11.0-cp39-abi3-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl:

Publisher: publish-wheels.yml on AVSLab/basilisk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file bsk-2.11.0-cp39-abi3-macosx_11_0_arm64.whl.

File metadata

  • Download URL: bsk-2.11.0-cp39-abi3-macosx_11_0_arm64.whl
  • Upload date:
  • Size: 87.3 MB
  • Tags: CPython 3.9+, macOS 11.0+ ARM64
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for bsk-2.11.0-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 711980b57bea7ecfa266cb024598d9e55bf496ec0d6735689bc1141a63fde532
MD5 993fa42166d3de59bcf86df4e3eae8ca
BLAKE2b-256 b3f63ac1ee5cb1b800b14c6792724abbc24c906901aa8259f6ed7343af25f20b

See more details on using hashes here.

Provenance

The following attestation bundles were made for bsk-2.11.0-cp39-abi3-macosx_11_0_arm64.whl:

Publisher: publish-wheels.yml on AVSLab/basilisk

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page