Building from Source

For advanced users and developers who want to customize or debug Basilisk. For most users the precompiled version available on PyPI is sufficient. See the Install Instructions for more information.

Note

To use the legacy ExternalModules path that compiles custom modules into the Basilisk package, Basilisk must be built from source with pathToExternalModules. The recommended prebuilt PyPI install, pip install "bsk[all]", is designed for most users and includes all optional Basilisk component wheels. For out-of-tree C++ modules that do not need to live inside Basilisk.ExternalModules, use Basilisk plugins.

Contents:

• Download Source Code
• Setup On Linux
• Setup On macOS
• Setup On Windows
• Building the Software Framework
• Building Custom Modules
• Using a Custom Python Installation
• Advanced: Directly Building the Software Framework Using Conan
• Advanced: Building Pre-Compiled Basilisk Wheels
• Containers