sorcha.utilities.sorcha_demo_command

Functions

get_demo_command()

Returns the current working version of the Sorcha demo command as a string.

print_demo_command([printall])

Prints the current working version of the Sorcha demo command to the terminal, with

Module Contents

get_demo_command()[source]

Returns the current working version of the Sorcha demo command as a string. If the Sorcha run command changes, updating this function will ensure associated unit tests pass.

Parameters:

None.

Returns:

working sorcha demo command

Return type:

string

print_demo_command(printall=True)[source]

Prints the current working version of the Sorcha demo command to the terminal, with optional functionality to also tell the user how to copy the demo files.

Parameters:

printall (boolean, default=True) -- When True, prints the demo command plus the instructions for copying the demo files. When False, prints the demo command only.

Return type:

None.