config.py File Reference

Namespaces
	carputils.settings.config

Functions
def	carputils.settings.config.carputils_root_dir ()
def	carputils.settings.config.filename ()
	Determine carputils settings file name. More...
def	carputils.settings.config.assert_type (name, value, type, sequence=False)
	Raise an error if the value is not of the correct type. More...
def	carputils.settings.config.load ()
	Load the settings file. More...
def	carputils.settings.config.default_settings (software_root=None, regression_ref=None, regression_pkg=['devtests'], regression_temp=None, meshalyzer_dir=None, mesh_dir=None, meshtool_dir=None, limpetgui_dir=None, opencarp_src=None, mpiexec=None, flavor=None, email=None, name=None, orcid=None)
	Determine the default configuration options for the settings.yaml file. More...
def	carputils.settings.config.new (filename, args, kwargs)
	Generate a new settings file with the default settings. More...
def	carputils.settings.config.update (filename)
	Update the keys in the settings file using the backwards compatability list. More...
def	carputils.settings.config.yaml_format_seq (seq)
	Format a sequence in YAML syntax. More...
def	carputils.settings.config.yaml_format_dict (seq)
	Format a dictionary in YAML syntax. More...
def	carputils.settings.config.write_settings_yaml (fields, filename)
	Write the settings file with the provided fields. More...

Variables
dictionary	carputils.settings.config.BACKWARDS_COMPAT_MAPPING
list	carputils.settings.config.BACKWARDS_COMPAT_REMOVED
dictionary	carputils.settings.config.VALIDATION_SINGLE
dictionary	carputils.settings.config.VALIDATION_SEQUENCE
list	carputils.settings.config.PATHS
string	carputils.settings.config.NOSETTINGS_TEMPLATE