Model

class GEBModel(config, files, mode='w', timing=False)[source]

GEB parent class.

Parameters:

  • config (dict) – Filepath of the YAML-configuration file (e.g. model.yml).

  • name – Name of model.

  • xmin – Minimum x coordinate.

  • xmax – Maximum x coordinate.

  • ymin – Minimum y coordinate.

  • ymax – Maximum y coordinate.

  • args – Run arguments.

  • coordinate_system – Coordinate system that should be used. Currently only accepts WGS84.

property bounds

Property returning the bounds of the current model as tuple

Returns:

tuple – xmin, xmax, ymin, ymax bounds of the model

close()[source]

Finalizes the model.

Return type:

None

property current_day_of_year: int

Gets the current day of the year.

Returns:

day – current day of the year.

property current_time_unix_s: int

Gets the current time in unix seconds.

Returns:

time – current time in unix seconds.

estimate_risk()[source]

Estimate the risk of the model.

Return type:

None

run(initialize_only=False)[source]

Run the model for the entire period, and export water table in case of spinup scenario.

Return type:

None

property simulation_root: Path

Gets the simulation root.

Returns:

simulation_root – Path of the simulation root.

property simulation_root_spinup: Path

Gets the simulation root of the spinup.

Returns:

simulation_root – Path of the simulation root.

spinup(initialize_only=False)[source]

Run the model for the spinup period.

Return type:

None

step(report=True)[source]

Forward the model by the given the number of steps.

Parameters:

step_size – Number of steps the model should take. Can be integer or string day, week, month, year, decade or century.

Return type:

None

property xmax

Get model xmax

Returns:

float – xmax

property xmin

Get model xmin

Returns:

float – xmin

property ymax

Get model ymax

Returns:

float – ymax

property ymin

Get model ymin

Returns:

float – ymin