tools.py File Reference

Classes
class	carputils.tools.MaxNPAction
	Class to check that the maximum number of processes is not exceeded. More...
class	carputils.tools.PrintAction
	Class to print a unformatted message like '–help' and exit. More...

Namespaces
	carputils.tools
	Functions for creating run scripts for openCARP simulations and other tools.

Functions
def	carputils.tools.basic_parser (showdefault=True, overwrite_behaviour=OVERWRITE_BEHAVIOUR[0], formatter_cls=None)
def	carputils.tools.standard_parser (showdefault=True)
	Generate a standard argument parser for collection of common options. More...
def	carputils.tools.basic_job_id (args)
	Generate default job ID. More...
def	carputils.tools.basicexample (parser=basic_parser, job_id=basic_job_id, summary=True, temp=False)
	Generate a decorator for openCARP example run function. More...
def	carputils.tools.carp_job_id (args)
	Generate default job ID. More...
def	carputils.tools.carpexample (parser=standard_parser, job_id=carp_job_id, meshdir=None, clean_pattern=r'^(\d{4}-\d{2}-\d{2})|(mesh)', simple=False, summary=True, temp=False, mkdir=True)
	Generate a decorator for openCARP example run function. More...
def	carputils.tools.carp_cmd (parfile=None, mech_symmetric=False)
	Construct the basic openCARP command line. More...
def	carputils.tools.list_to_string (pl)
def	carputils.tools.gen_physics_opts (ExtraTags=None, IntraTags=None, EikonalTags=None, MechTags=None, FluidTags=None, EMI=False)
def	carputils.tools.simfile_path (path, mesh=False)
	Deprecated alias for bundle_include. More...
def	carputils.tools.bundle_include (path, mesh=False, caller_name='bundle_include')
	Use this function to indicate that the file given as an argument has to be included in the experiment bundles. More...
def	carputils.tools.resolve_bundle_include (path, mesh)
	Helper function for copying files marked with bundle_include within the bundle. More...

Variables
	carputils.tools.OVERWRITE_BEHAVIOUR = tuple(clean.OVERWRITE_MODES.keys())
	carputils.tools.maxnp = None