Weather Generator API

class rwgen.WeatherGenerator(spatial_model, project_name, output_folder, latitude, longitude, easting=None, northing=None, elevation=None, easting_min=None, easting_max=None, northing_min=None, northing_max=None)
__init__(spatial_model, project_name, output_folder, latitude, longitude, easting=None, northing=None, elevation=None, easting_min=None, easting_max=None, northing_min=None, northing_max=None)

Weather generator to simulate rainfall, temperature, potential evapotranspiration and other weather variables.

More explanation and an example.

Notes

The easting, northing and elevation arguments are only needed for a point (gauge/site) model.

The easting_min, easting_max, northing_min and northing_max arguments apply only to above spatial model.

Parameters:

  • spatial_model (bool) – Flag to indicate whether point or spatial model.

  • project_name (str) – A name for the gauge/site location, domain or catchment.

  • output_folder (str) – Root folder for model output.

  • latitude (int or float) – Latitude in decimal degrees (negative for southern hemisphere).

  • longitude (int or float) – Longitude in decimal degrees (negative for western hemisphere).

  • easting (int or float) – Easting (in metres) of gauge/site for a point model.

  • northing (int or float) – Northing (in metres) of gauge/site for a point model.

  • elevation (int or float) – Elevation (in metres above sea level) of gauge/site for a point model.

  • easting_min (int or float) – Minimum easting (in metres) of domain bounding box for spatial model.

  • easting_max (int or float) – Maximum easting (in metres) of domain bounding box for spatial model.

  • northing_min (int or float) – Minimum northing (in metres) of domain bounding box for spatial model.

  • northing_max (int or float) – Maximum northing (in metres) of domain bounding box for spatial model.

Methods

__init__(spatial_model, project_name, ...[, ...])

Weather generator to simulate rainfall, temperature, potential evapotranspiration and other weather variables.

initialise_rainfall_model([...])

Initialise rainfall model.

initialise_weather_model(input_timeseries[, ...])

Initialise weather model.

simulate([output_types, output_subfolders, ...])

Simulate rainfall and other weather (temperature, PET, ...) variables.

Attributes

rainfall_model

Instance of NSRP rainfall model

weather_model

Instance of regression-based weather model
rainfall_model

Instance of NSRP rainfall model

Type:

rwgen.RainfallModel

weather_model

Instance of regression-based weather model

Type:

rwgen.WeatherModel