tardis.io.configuration.config_reader module

class tardis.io.configuration.config_reader.ConfigWriterMixin(*args: Any, **kwargs: Any)

Bases: HDFWriterMixin

Overrides HDFWriterMixin to obtain HDF properties from configuration keys

Create a new instance and initialize HDF properties.

Parameters:

*argsAny

Positional arguments passed to the parent class.

**kwargsAny

Keyword arguments passed to the parent class.

Returns:

HDFWriterMixin

The new instance with initialized HDF properties.

get_properties()

Get properties for HDF storage.

Returns:

Dict[str, Any]

Dictionary of property names and their values.

class tardis.io.configuration.config_reader.Configuration(value=None)

Bases: ConfigurationNameSpace, ConfigWriterMixin

Tardis configuration class

Create a new instance and initialize HDF properties.

Parameters:

*argsAny

Positional arguments passed to the parent class.

**kwargsAny

Keyword arguments passed to the parent class.

Returns:

HDFWriterMixin

The new instance with initialized HDF properties.

classmethod from_config_dict(config_dict: dict, validate: bool = True, config_dirname: str = '') → Configuration

Validating and subsequently parsing a config file.

Parameters:

config_dictdict

dictionary of a raw unvalidated config file

validatebool

Turn validation on or off.

config_dirnamestr

Directory against which relative file paths in the configuration are resolved.

Returns:

tardis.config_reader.Configuration

classmethod from_yaml(fname, *args, **kwargs)

Read a configuration from a YAML file

Parameters:

fnamestr

filename or path

hdf_name = 'simulation'

static parse_convergence_section(convergence_section_dict)

Parse the convergence section dictionary

Parameters:

convergence_section_dictdict

dictionary

exception tardis.io.configuration.config_reader.ConfigurationError

Bases: ValueError

class tardis.io.configuration.config_reader.ConfigurationNameSpace(value=None)

Bases: dict

The configuration name space class allows to wrap a dictionary and adds utility functions for easy access. Accesses like a.b.c are then possible

Code from http://goo.gl/KIaq8I

Parameters:

config_dictdict

configuration dictionary

Returns:

config_nsConfigurationNameSpace

deepcopy()

classmethod from_config_dict(config_dict)

Validating a config file.

Parameters:

config_dictdict

dictionary of a raw unvalidated config file

Returns:

tardis.config_reader.Configuration

classmethod from_yaml(fname)

Read a configuration from a YAML file

Parameters:

fnamestr

filename or path

get_config_item(config_item_string)

Get configuration items using a string of type ‘a.b.param’

Parameters:

config_item_stringstr

string of shape ‘section1.sectionb.param1’

set_config_item(config_item_string, value)

set configuration items using a string of type ‘a.b.param’

Parameters:

config_item_stringstr

string of shape ‘section1.sectionb.param1’

value

value to set the parameter with it

tardis.io.configuration.config_reader.cns_representer(dumper, data)

Represents Configuration as dict

Parameters:

dumper

YAML dumper object

data

ConfigurationNameSpace object

Returns:

yaml dumper representation of Configuration as dict

tardis.io.configuration.config_reader.quantity_representer(dumper, data)

Represents Astropy Quantity as str

Astropy’s own YAML representer (astropy.io.misc.yaml) writes a tagged !astropy.units.Quantity mapping. TARDIS configurations write quantities as plain strings such as 10 km / s, which YAMLLoader parses back, so this representer keeps dumped configurations in the same format as the input files.

Parameters:

dumper

YAML dumper object

data

ConfigurationNameSpace object

Returns:

yaml dumper representation of Quantity as string