Generate or update a carputils settings file. More...

Variables
string	epilog

	parser = argparse.ArgumentParser(description=__doc__, epilog=epilog)

	help

	gnew = parser.add_argument_group('new settings file options')

	type

	action

	args = parser.parse_args()

dictionary	kwargs

string	regression_ref_path = os.path.dirname(os.path.dirname(os.path.dirname(os.path.dirname(inspect.getfile(new))))) + '/experiments/regression-references/'

list	cmd = ['git', 'config', '--get', 'user.email']

	email = subprocess.check_output(cmd).rstrip()

	name = subprocess.check_output(cmd).rstrip()

Detailed Description

Generate or update a carputils settings file.

Variable Documentation

◆ action

bin.cusettings.action

◆ args

bin.cusettings.args = parser.parse_args()

◆ cmd

list bin.cusettings.cmd = ['git', 'config', '--get', 'user.email']

◆ email

bin.cusettings.email = subprocess.check_output(cmd).rstrip()

◆ epilog

string bin.cusettings.epilog

Initial value:

 =  """
 This tool updates or generates a new carputils settings file. The action
 depends on whether the specified file already exists.
 
 New settings files are populated with some default options; some may be
 customised with the relevant optional command line arguments.
 
 Updates to the settings file are done using an internal options backwards
 compatibility mapping. Other command line options to this script are ignored.
 """

◆ gnew

bin.cusettings.gnew = parser.add_argument_group('new settings file options')

◆ help

bin.cusettings.help

◆ kwargs

dictionary bin.cusettings.kwargs

Initial value:

 =  {'software_root': None,
               'regression_ref': None,
               'regression_pkg': ['devtests'],
               'regression_temp': None,
               'meshalyzer_dir': None,
               'meshtool_dir': None,
               'limpetgui_dir': None,
               'mesh_dir': None,
               'opencarp_src': None,
               'mpiexec': None,
               'flavor': None,
               'email': None,
               'name': None,
               'orcid': None}

◆ name

bin.cusettings.name = subprocess.check_output(cmd).rstrip()

◆ parser

bin.cusettings.parser = argparse.ArgumentParser(description=__doc__, epilog=epilog)

◆ regression_ref_path

string bin.cusettings.regression_ref_path = os.path.dirname(os.path.dirname(os.path.dirname(os.path.dirname(inspect.getfile(new))))) + '/experiments/regression-references/'

◆ type

bin.cusettings.type

Variables