atomica.framework.generate_framework_doc

atomica.framework.generate_framework_doc(framework, fname, databook_only=False)[source]

Generate a framework documentation template file

This function takes in a Framework and a file name, and writes a Markdown template file for the framework

Parameters:

  • F – A ProjectFramework instance

  • fname – The filename to write

  • databook_only – If True, only quantities appearing in the databook will be shown

Returns:

None