Skip to main content

Vendored Basilisk SDK headers, runtime, and CMake integration for plugin authors

Project description

Basilisk SDK (bsk-sdk)

A self-contained Python wheel that gives external projects everything they need to build Basilisk compatible SWIG plugins without vendoring the full simulation codebase.

Quick start

pip install bsk-sdk

Then in your plugin's CMakeLists.txt:

find_package(bsk-sdk CONFIG REQUIRED)

bsk_add_swig_module(
  TARGET myPlugin
  INTERFACE swig/myPlugin.i
  SOURCES myPlugin.cpp
  LINK_LIBS bsk::plugin
)

See examples/custom-atm-plugin/ for a complete working example.

Syncing from Basilisk

The SDK vendors a curated subset of Basilisk headers and sources. These are synced from a pinned Basilisk commit via a Git submodule.

git submodule update --init --recursive
python3 tools/sync_all.py
pip install -e .

Or opt into auto-sync during build:

BSK_SDK_AUTO_SYNC=1 pip install -e .

Updating to a newer Basilisk version

cd external/basilisk
git fetch && git checkout <tag-or-commit>
cd ../..
python3 tools/sync_all.py

Versioning

The bsk-sdk package version tracks the Basilisk version it was synced from (e.g. bsk-sdk==2.9.1 contains headers from Basilisk v2.9.1).

At CMake configure time, the SDK checks that the installed Basilisk version matches and errors out on a mismatch. This prevents silent ABI incompatibilities where plugins are compiled against headers from one Basilisk version but linked against a different runtime.

Project details


Download files

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

Source Distribution

bsk_sdk-2.10.0.tar.gz (216.8 kB view details)

Uploaded Source

Built Distribution

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

bsk_sdk-2.10.0-py3-none-any.whl (2.9 MB view details)

Uploaded Python 3

File details

Details for the file bsk_sdk-2.10.0.tar.gz.

File metadata

  • Download URL: bsk_sdk-2.10.0.tar.gz
  • Upload date:
  • Size: 216.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for bsk_sdk-2.10.0.tar.gz
Algorithm Hash digest
SHA256 af7005a184cdf4ea6db432b246340062e95fced94d53ccd85af497aef8ffb2a9
MD5 b3a3ad76b164f60ed2228d4b2b06509a
BLAKE2b-256 e094c6f202f93ddf92a18be5ca7f7f155a05a24d4292c93abc46afca5ec0fc28

See more details on using hashes here.

Provenance

The following attestation bundles were made for bsk_sdk-2.10.0.tar.gz:

Publisher: publish-wheels.yml on AVSLab/bsk_sdk

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_sdk-2.10.0-py3-none-any.whl.

File metadata

  • Download URL: bsk_sdk-2.10.0-py3-none-any.whl
  • Upload date:
  • Size: 2.9 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for bsk_sdk-2.10.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9883e459e262eb8e6f8ce2daaa110c3a448e366bf2ef42fa7f78851041ecd6ac
MD5 f610a17ac5f573b8642744372d16afbf
BLAKE2b-256 02bcb05ba1b993aa683364ac59b2fd0a50bd405e4b2610a64640859f6023ceff

See more details on using hashes here.

Provenance

The following attestation bundles were made for bsk_sdk-2.10.0-py3-none-any.whl:

Publisher: publish-wheels.yml on AVSLab/bsk_sdk

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 Pingdom Monitoring Sentry Error logging StatusPage Status page