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()

Check the destination parent without changing the working directory.

createCModule()

Create a C draft, preserving existing files if generation fails.

createCppModule()

Create a C++ draft, preserving existing files if generation fails.

createRstFile(moduleType)

Write the rendered documentation into the active staging directory.

createTestFile(module_type)

Write the rendered smoke test into the active staging directory.

readLicense()

Read the Basilisk license file