Model

class GEBModel(config, files, spinup=False, use_gpu=False, gpu_device=0, timing=False, crs=4326, mode='w')[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.

Initializes the agent-based model.

Parameters:

  • config_path – Filepath of the YAML-configuration file.

  • args – Run arguments.

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

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.

run()[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.

step(step_size=1)[source]

Forward the model by the given the number of steps.

Parameters:

step_size (Union[int, str]) – Number of steps the model should take. Can be integer or string day, week, month, year, decade or century.

Return type:

None