carputils.settings.config Namespace Reference

Functionality for the parsing of a carputils settings file. More...

Functions
def	carputils_root_dir ()
def	filename ()
	Determine carputils settings file name. More...
def	assert_type (name, value, type, sequence=False)
	Raise an error if the value is not of the correct type. More...
def	load ()
	Load the settings file. More...
def	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	new (filename, *args, **kwargs)
	Generate a new settings file with the default settings. More...
def	update (filename)
	Update the keys in the settings file using the backwards compatability list. More...
def	yaml_format_seq (seq)
	Format a sequence in YAML syntax. More...
def	yaml_format_dict (seq)
	Format a dictionary in YAML syntax. More...
def	write_settings_yaml (fields, filename)
	Write the settings file with the provided fields. More...

Variables
dictionary	BACKWARDS_COMPAT_MAPPING
list	BACKWARDS_COMPAT_REMOVED
dictionary	VALIDATION_SINGLE
dictionary	VALIDATION_SEQUENCE
list	PATHS
string	NOSETTINGS_TEMPLATE

Detailed Description

Functionality for the parsing of a carputils settings file.

Function Documentation

assert_type()

def carputils.settings.config.assert_type	(		name,
			value,
			type,
			sequence = False
	)

Raise an error if the value is not of the correct type.

Parameters

name str Name of the variable, used for error messages value object Object to test type of type type Type to check value is sequence bool, optional If True, expect value to be a sequence of type

carputils_root_dir()

def carputils.settings.config.carputils_root_dir

(

)

default_settings()

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.

Parameters

software_root str, optional Default path for built software packages regression_ref str, optional Location of regression reference solution repositories regression_pkg list, optional Default packages to load tests from regression_temp str, optional Temporary location to store simulation results meshalyzer_dir str, optional Parent directory of meshalyzer executable meshtool_dir str, optional Parent directory of meshtool executable limpetgui_dir str, optional Parent directory of main.py executable opencarp_src str, optional Directory containing openCARP source files mesh_dir str, optional Default path to look for meshes flavor str, optional Default solver used (pt, petsc, direct, or ginkgo) email str, optional Email address consistent with your git configuration (.gitconfig) name str, optional User name consistent with your git configuration (.gitconfig) orcid str, optional ORCID of the user

Returns
-------
dict
    The default settings

filename()

def carputils.settings.config.filename

(

)

Determine carputils settings file name.

Returns

str The settings file path

load()

def carputils.settings.config.load

(

)

Load the settings file.

Returns

SettingsNamespace The loaded settings

new()

def carputils.settings.config.new	(		filename,
		*	args,
		**	kwargs
	)

Generate a new settings file with the default settings.

Extra arguments are passed through to default_settings

Parameters

filename str The path of the settings file to generate

update()

def carputils.settings.config.update

(

filename

)

Update the keys in the settings file using the backwards compatability list.

Parameters

filename str The path of the settings file to update

write_settings_yaml()

def carputils.settings.config.write_settings_yaml	(		fields,
			filename
	)

Write the settings file with the provided fields.

Parameters

fields dict Data to insert into configuration file template filename str Filename to write file to

yaml_format_dict()

def carputils.settings.config.yaml_format_dict

(

seq

)

Format a dictionary in YAML syntax.

yaml_format_seq()

def carputils.settings.config.yaml_format_seq

(

seq

)

Format a sequence in YAML syntax.

Variable Documentation

BACKWARDS_COMPAT_MAPPING

dictionary carputils.settings.config.BACKWARDS_COMPAT_MAPPING

Initial value:

=  {'MPI_EXEC':       'MPIEXEC',
                            'HW_DEFAULT':     'PLATFORM',
                            'SILENT_DEFAULT': 'SILENT',
                            'VIS_DEFAULT':    'VISUALIZE',
                            'FLAVOR_DEFAULT': 'FLAVOR',
                            'DIRECT_DEFAULT': 'DIRECT_SOLVER',
                            'PURK_DEFAULT':   'PURK_SOLVER',
                            'LIMPET_GUI_DIR': 'LIMPETGUI_DIR'}

BACKWARDS_COMPAT_REMOVED

list carputils.settings.config.BACKWARDS_COMPAT_REMOVED

Initial value:

=  ['HOME',
                            'CARP_TYPE',
                            'WITH_MECH',
                            'DEBUG']

NOSETTINGS_TEMPLATE

string carputils.settings.config.NOSETTINGS_TEMPLATE

Initial value:

=  """ERROR: No carputils settings file was found.
The resolution order is:
    - The full path (not just the directory) set by the environment variable
      CARPUTILS_SETTINGS
    - settings.yaml in the root of the carputils repository
    - ./settings.yaml
    - ~/.config/carputils/settings.yaml
The following paths were tried:
    - {}
Creating your settings file at ~/.config/carputils/settings.yaml is recommended.
To do so, please run:
    cusettings ~/.config/carputils/settings.yaml
"""

PATHS

list carputils.settings.config.PATHS

Initial value:

=  ['CARP_EXE_DIR',
         'MESHALYZER_DIR',
         'LIMPETGUI_DIR',
         'TUNING_DIR',
         'MESH_DIR',
         'OPENCARP_SRC',
         'REGRESSION_TEMP',
         'REGRESSION_REF']

VALIDATION_SEQUENCE

dictionary carputils.settings.config.VALIDATION_SEQUENCE

Initial value:

=  {'CARP_EXE_DIR':   str,
                       'REGRESSION_PKG': str}

VALIDATION_SINGLE

dictionary carputils.settings.config.VALIDATION_SINGLE

Initial value:

=  {'MESHALYZER_DIR':  str,
                     'LIMPETGUI_DIR':   str,
                     'TUNING_DIR':      str,
                     'MESH_DIR':        str,
                     'MESHTOOL_DIR':    str,
                     'OPENCARP_SRC':    str,
                     'REGRESSION_TEMP': str,
                     'REGRESSION_REF':  str,
                     'MPIEXEC':         str,
                     'SILENT':          bool,
                     'VISUALIZE':       bool,
                     'FLAVOR':          str,
                     'PLATFORM':        str,
                     'BUILD':           str,
                     'DIRECT_SOLVER':   str,
                     'PURK_SOLVER':     str,
                     'EMAIL':           str,
                     'NAME':            str,
                     'ORCID':           str,
                     'MAX_NP':          int}