carputils
Doxygen code documentation for the python framework controlling openCARP
Namespaces | Functions | Variables
carphelp File Reference

Namespaces

 bin.carphelp
 openCARP parameters helper
 

Functions

def bin.carphelp.highlight_keywords (string)
 For each keyword in the predefined list KEYWORDS, find the pattern keyword+':' in the string and highlight keyword. More...
 
def bin.carphelp.highlight_types (string, prefix='', suffix='')
 For each element dtype in DTYPES, highlight dtype if prefix+dtype+suffix is contained in string. More...
 
def bin.carphelp.build_helpcmd (carpexec, args)
 
def bin.carphelp.main (carpexec, arg, colors=True)
 Prints documentation about matching openCARP parameters. More...
 
def bin.carphelp.print_help ()
 

Variables

string bin.carphelp.GRCOL = '\33[1;32m'
 
string bin.carphelp.YLCOL = '\33[1;33m'
 
string bin.carphelp.BLCOL = '\33[1;34m'
 
string bin.carphelp.NOCOL = '\33[0m'
 
tuple bin.carphelp.KEYWORDS
 
tuple bin.carphelp.DTYPES
 
 bin.carphelp.cli
 
 bin.carphelp.carpexec = settings.execs['CARP']
 
 bin.carphelp.args = sys.argv[1:]
 
bool bin.carphelp.colors = True