Developer Information

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
  • Running Unit and Integrated Tests
  • Formatting Code Files using pre-commit and clang-format
• Accessing the Debugger for C/C++ Basilisk Modules
  • Motivation
  • Basilisk build requirements
  • How to catch breakpoints in a C/C++ module
• Deprecating code in Basilisk
  • Motivation
  • Deprecating Python Code
  • Deprecating C++ Code Wrapped by SWIG
• Making a New C/C++ Basilisk Module
• Using Sphinx to Document Basilisk Modules and Folders
  • Adding Documentation to a Basilisk Module
  • Adding Documentation to a Basilisk Folder
  • Overriding the Folder’s Auto-Generated index.rst File
• Creating the HTML Basilisk Documentation using Sphinx/Doxygen
  • Documentation Description
  • Tool Requirements
  • Making the HTML Documentation Folder
• 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
• Adding Support Data Files
  • Folder Layout
  • Step 1 — Add the File to supportData/
  • Step 2 — Ensure makeRegistry.py will include the file
  • Step 3 — Regenerate the registrySnippet.py file
  • Step 4 — Update dataFetcher.py (Enums and Base Paths)
  • External Data Sources