Class ReadYaml

class tools.inputparser.ReadYaml(filename)

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.
_defineRain(k, rStart, rMap, rUniform, raindata)	Define precipitation conditions.
_defineTectonic(k, tecSort, tecdata)	Define tectonic conditions.
_extraCompaction()	Read compaction additional parameters.
_extraDomain()	Read domain additional information.
_readBackwardPaleo()	Force model with backward paleomaps.
_readCompaction()	Read compaction parameters.
_readDomain()	Read domain definition, boundary conditions and flow direction parameters.
_readForcePaleo()	Get series of paleomaps to force the model through time.
_readHillslope()	Read hillslope parameters.
_readOut()	Parse output directory.
_readRain()	Parse rain forcing conditions.
_readSPL()	Read surface processes bedrock parameters.
_readSealevel()	Define sealevel evolution.
_readTectonic()	Parse tectonic forcing conditions.
_readTime()	Read simulation time declaration.
_storeTectonic(k, tecStart, zMap, tMap, ...)	Record tectonic conditions.

Private functions

ReadYaml._addTime(timeDict)

Read additional time parameters.

ReadYaml._defineRain(k, rStart, rMap, rUniform, raindata)

Define precipitation conditions.

Parameters

• k – precipitation event number

• rStart – precipitation event start time

• rMap – precipitation map file event

• rUniform – precipitation uniform value event

• raindata – pandas dataframe storing each precipitation event

Returns

appended raindata

ReadYaml._defineTectonic(k, tecSort, tecdata)

Define tectonic conditions.

Parameters

• k – tectonic event number

• tecSort – sorted tectonic event

• tecdata – pandas dataframe storing each tectonic event

Returns

appended tecdata

ReadYaml._extraCompaction()

Read compaction additional parameters.

ReadYaml._extraDomain()

Read domain additional information.

ReadYaml._readBackwardPaleo()

Force model with backward paleomaps.

ReadYaml._readCompaction()

Read compaction parameters.

ReadYaml._readDomain()

Read domain definition, boundary conditions and flow direction parameters.

ReadYaml._readForcePaleo()

Get series of paleomaps to force the model through time.

ReadYaml._readHillslope()

Read hillslope parameters.

ReadYaml._readOut()

Parse output directory.

ReadYaml._readRain()

Parse rain forcing conditions.

ReadYaml._readSPL()

Read surface processes bedrock parameters.

ReadYaml._readSealevel()

Define sealevel evolution.

ReadYaml._readTectonic()

Parse tectonic forcing conditions.

ReadYaml._readTime()

Read simulation time declaration.

ReadYaml._storeTectonic(k, tecStart, zMap, tMap, tStep, tEnd, tecdata)

Record tectonic conditions.

Parameters

• k – tectonic event number

• tecStart – tectonic event start time

• zMap – horizontal tectonic displacement file

• tMap – vertical tectonic displacement file

• tStep – tectonic time step

• tEnd – tectonic event end time

• tecdata – pandas dataframe storing each tectonic event

Returns

appended tecdata

previous

Class StraMesh

next

Class WriteMesh