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 27, 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:
Latest release

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 27, 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.1.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.1-cp39-abi3-win_amd64.whl (66.0 MB view details)

Uploaded CPython 3.9+Windows x86-64

bsk-2.11.1-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.1-cp39-abi3-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl (80.3 MB view details)

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

bsk-2.11.1-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.1.tar.gz.

File metadata

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

File hashes

Hashes for bsk-2.11.1.tar.gz
Algorithm Hash digest
SHA256 ea2072ca233c6ec24eba18e039319bf9e4ab3a0a41bd75bae95c3f93d64e14f7
MD5 65f3160c63b7067d01e2f4da1c6b0a9d
BLAKE2b-256 14d5dc05965c8483b0950b4d568d0a412a182c6a55bbadf4ae378959de6dabae

See more details on using hashes here.

Provenance

The following attestation bundles were made for bsk-2.11.1.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.1-cp39-abi3-win_amd64.whl.

File metadata

  • Download URL: bsk-2.11.1-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.14

File hashes

Hashes for bsk-2.11.1-cp39-abi3-win_amd64.whl
Algorithm Hash digest
SHA256 4d932881e630319fe751abf4e1ecde3aee8e7380cce579ec5447cf9652689b11
MD5 ecd85b3a4968d449690bc6ba33e18cc4
BLAKE2b-256 4846029a16ebc8a7dcaf99d087e1ebaa1d57d8e70a904d6e53bd980e181bd71c

See more details on using hashes here.

Provenance

The following attestation bundles were made for bsk-2.11.1-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.1-cp39-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl.

File metadata

File hashes

Hashes for bsk-2.11.1-cp39-abi3-manylinux_2_27_x86_64.manylinux_2_28_x86_64.whl
Algorithm Hash digest
SHA256 89bc5ef549f16f04935e2dbb4a5ce2f3cc424d5ff21e9f9ed21ce2246f5ca01d
MD5 e61a49eab623cf41c34297f28601f243
BLAKE2b-256 3de284328657c508c9bdb8c5fa1df377e128d6cea2898b4cc038f7a866b21d21

See more details on using hashes here.

Provenance

The following attestation bundles were made for bsk-2.11.1-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.1-cp39-abi3-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl.

File metadata

File hashes

Hashes for bsk-2.11.1-cp39-abi3-manylinux_2_27_aarch64.manylinux_2_28_aarch64.whl
Algorithm Hash digest
SHA256 bcfed0f23f12078fa5b28ce17027d668385d7d7766010a34c023c9feaae7ec4a
MD5 1aa486a8384e6e78c976bc4a0dfe1896
BLAKE2b-256 6e84cb5528fb8241f920c058151e16a64680265c857ebb08e8a8baa575828ead

See more details on using hashes here.

Provenance

The following attestation bundles were made for bsk-2.11.1-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.1-cp39-abi3-macosx_11_0_arm64.whl.

File metadata

  • Download URL: bsk-2.11.1-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.14

File hashes

Hashes for bsk-2.11.1-cp39-abi3-macosx_11_0_arm64.whl
Algorithm Hash digest
SHA256 f179faa2e4a2ecfa2f65bbde73a4eebf0a12f20158c5faaec1fb630d90634f73
MD5 9c4fb892b8813e216b1a9de63fdbe060
BLAKE2b-256 73ee2bd5a8df9f59fe66fd7f378a3fe9f509d93eae634904713ebf8921c8357a

See more details on using hashes here.

Provenance

The following attestation bundles were made for bsk-2.11.1-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