makeDraftModule

This script is used to create a Basilisk module folder given the basic I/O and naming information.

• Modify either fillCppInfo() or fillCInfo() to contain the desired information for the new BSK module.

• edit the __main__ routine at the end of the file to call the desired module type with createCppModule() or createCModule.

• run the script from the command line using python3 makeDraftModule.py

makeDraftModule.fillCInfo(module)

Fill in the C module information. This should be edited before running to meet the new module needs.

makeDraftModule.fillCppInfo(module)

Fill in the C++ module information. This should be edited before running to meet the new module needs.

class makeDraftModule.moduleGenerator

Bases: object

class to generate draft Basilisk modules

checkPathToNewFolderLocation()

Make sure the supplied module destination path is correct

createCModule()

Create a C Basilisk module

createCppModule()

Create a C++ Basilisk module

createNewModuleFolder()

Create the new module folder

createRstFile()

Create the Module RST documentation draft.

createTestFile(type)

Create a functioning python unit test file that loads the new module, creates and connect blank input messages, and sets up recorder modules for each output message.

readLicense()

Read the Basilisk license file