Class ReadYaml#

class tools.inputparser.ReadYaml(filename)[source]#

Class for reading simulation input file and initialising model parameters.

Definition of input parameters is provided in the User Documentation

Initialise

__init__(filename)

Parsing YAML file.

Private Methods

`_addTime`(timeDict)	Read additional time parameters.
`_defineErofactor`(k, sStart, sMap, sUniform, ...)	Define sediment surface erodibility factor conditions.
`_defineRain`(k, rStart, rMap, rUniform, ...)	Define precipitation conditions.
`_defineTectonics`(k, tecSort, tecdata)	Define tectonics conditions.
`_extraDomain`()	Read domain additional information.
`_extraHillslope`()	Read extra hillslope parameters.
`_extraOrography`(oroDict)	Read domain additional information.
`_readCompaction`()	Read compaction parameters.
`_readDomain`()	Read domain definition, boundary conditions and flow direction parameters.
`_readErofactor`()	Parse erodibility factor based on surface geology.
`_readFlex`()	Parse flexural isostasy variables.
`_readHillslope`()	Read hillslope parameters.
`_readIce`()	Parse ice flow variables.
`_readOrography`()	Parse orographic precipitation variables.
`_readOut`()	Parse output directory.
`_readRain`()	Parse rain and evaporation forcing conditions.
`_readSoilInfo`()	Read soil information parameters.
`_readSPL`()	Read surface processes erosion and deposition laws parameters.
`_readSealevel`()	Define sealevel evolution.
`_readTectonics`()	Parse tectonics forcing conditions.
`_readTime`()	Read simulation time declaration.
`_storeTectonics`(k, tecStart, hMap, tMap, ...)	Record tectonic conditions.

Private functions#

ReadYaml._addTime(timeDict)[source]#: Read additional time parameters.

ReadYaml._defineErofactor(k, sStart, sMap, sUniform, sedfacdata)[source]#

Define sediment surface erodibility factor conditions.

Parameters:

k – erodibility factor map number
sStart – erodibility factor map start time
sMap – erodibility factor map file event
sUniform – erodibility factor uniform value event
sedfacdata – pandas dataframe storing each erodibility factor map

Returns:

appended sedfacdata

ReadYaml._defineRain(k, rStart, rMap, rUniform, rZscale, raindata)[source]#

Define precipitation conditions.

Parameters:

k – precipitation event number
rStart – precipitation event start time
rMap – precipitation map file event
rUniform – precipitation uniform value event
rZscale – precipitation scaled with elevation value event
raindata – pandas dataframe storing each precipitation event

Returns:

appended raindata

ReadYaml._defineTectonics(k, tecSort, tecdata)[source]#

Define tectonics conditions.

Parameters:

k – tectonic event number
tecSort – sorted tectonic event
tecdata – pandas dataframe storing each tectonic event

Returns:

appended tecdata

ReadYaml._extraDomain()[source]#: Read domain additional information.

ReadYaml._extraHillslope()[source]#: Read extra hillslope parameters.

ReadYaml._extraOrography(oroDict)[source]#: Read domain additional information.

ReadYaml._readCompaction()[source]#: Read compaction parameters.

ReadYaml._readDomain()[source]#: Read domain definition, boundary conditions and flow direction parameters.

ReadYaml._readErofactor()[source]#: Parse erodibility factor based on surface geology.

ReadYaml._readFlex()[source]#: Parse flexural isostasy variables.

ReadYaml._readHillslope()[source]#: Read hillslope parameters.

ReadYaml._readIce()[source]#: Parse ice flow variables.

ReadYaml._readOrography()[source]#: Parse orographic precipitation variables.

ReadYaml._readOut()[source]#: Parse output directory.

ReadYaml._readRain()[source]#

Parse rain and evaporation forcing conditions.

Both share the same [climate] YAML block. Each climate event row may declare rainfall (uniform/map/zscale) and, optionally, evaporation (evap_uniform/evap_map). Evaporation is opt-in: if no row has an evap field, self.evapdata ends up as None and the downstream solver bypasses both evap hooks.

ReadYaml._readSoilInfo()[source]#: Read soil information parameters.

ReadYaml._readSPL()[source]#: Read surface processes erosion and deposition laws parameters.

ReadYaml._readSealevel()[source]#: Define sealevel evolution.

ReadYaml._readTectonics()[source]#: Parse tectonics forcing conditions.

ReadYaml._readTime()[source]#: Read simulation time declaration.

ReadYaml._storeTectonics(k, tecStart, hMap, tMap, zMap, tecEnd, tecdata)[source]#

Record tectonic conditions.

Parameters:

k – tectonic event number
tecStart – tectonic event start time
hMap – horizontal tectonic information
tMap – vertical tectonic displacement information
zMap – elevation information
tEnd – tectonic event end time
tecdata – pandas dataframe storing each tectonic event

Returns:

appended tecdata