init

CLI utilities to scaffold a kMCpy Configuration YAML template.

kmcpy.cli.init.build_parser()[source]

Build parser for the standalone kmcpy-init style command.

Return type:

ArgumentParser

kmcpy.cli.init.build_template()[source]

Return a commented YAML template for Configuration.

Return type:

str

kmcpy.cli.init.main(argv=None)[source]

Entry point for generating template files.

Return type:

int

kmcpy.cli.init.write_template(output, force=False)[source]

Write the template to output and return the output path.

Return type:

Path