Skip to main content
Ctrl+K

basilisk documentation

  • API
  • Install
  • Developer
  • Releases
  • GitHub
  • API
  • Install
  • Developer
  • Releases
  • GitHub

Section Navigation

  • Coding Guidelines
  • Debugging Modules
  • Deprecating Code
  • Making a New C/C++ Basilisk Module
  • Using Sphinx to Document Modules and Folders
  • Basilisk Module Checkout List
  • Basilisk Architecture Support Documentation
  • Migrating Basilisk Modules from Version 1.X to 2.X
  • Migrating BSK Scripts to Python 3
  • Developer

Developer#

The following support files help with writing Basilisk modules.

  • Coding Guidelines
    • Motivation
    • What about non-conforming code?
    • Naming
    • General Guidelines
    • Modules
    • C/C++ Exceptions
    • Python Exceptions
  • Debugging Modules
    • Motivation
    • Basilisk build requirements
    • How to catch breakpoints in a C/C++ module
  • Deprecating Code
    • Motivation
    • Deprecating Python Code
    • Deprecating C++ Code Wrapped by SWIG
  • Making a New C/C++ Basilisk Module
    • Getting Started
    • Templates and Examples
    • Base Classes and Custom Methods
    • Linear Algebra and Kinematics Support
    • Finalizing and Contributing
  • Using Sphinx to Document Modules and Folders
    • Adding Documentation to a Module
    • Adding Documentation to a Folder
    • Overriding the Folder’s Auto-Generated index.rst File
  • Basilisk Module Checkout List
    • Branch Must Be Up to Date
    • Building Basilisk and Testing
    • Style and Formatting
    • Module Programming
    • Module Documentation
    • Module Functionality Testing
    • Module Integrated Test
    • Update Release Notes
  • Basilisk Architecture Support Documentation
  • Migrating Basilisk Modules from Version 1.X to 2.X
    • Motivation
    • Message Names
    • Creating New Message Definitions
    • Step-By-Step Guide to Upgrade a Basilisk Modules
  • Migrating BSK Scripts to Python 3
    • Dividing Scalars
    • Returning Lists Instead of Iterables
    • Range, Map, Zip
    • Print
    • Strings
    • Pyswice Imports

previous

Using a Custom Python Installation

next

Coding Guidelines

This Page

  • Show Source

© Copyright 2024, University of Colorado.

Created using Sphinx 8.2.3.

Built with the PyData Sphinx Theme 0.16.1.