rubem.configuration.model_configuration_file_v1

Configuration file format 1.0 (issues #179, #181, #182, #184; discussion #126).

The format is strict: unknown keys are rejected everywhere, and version must be "1.0". It is not yet read by the loader nor exposed on the command line; the model, its conversions from and to the legacy format and the resolution of the raster series are prepared here.

Raster series may be given in three ways: a list of dated entries (file_path, from, to), a monthly set of twelve rasters optionally replaced by one raster from a given year on (monthly, yearly_from, yearly_file_path), or a directory with a common file prefix (dir_path, files_prefix). The dates from/to accept the JSON-pointer references {"$ref": "#/simulation_period/start"} and {"$ref": "#/simulation_period/finish"}.

Classes

`Aggregation`	How the time series values are aggregated in space.
`CalibrationParameters`	Create a new model by parsing and validating input data from keyword arguments.
`Constants`	Create a new model by parsing and validating input data from keyword arguments.
`DateRef`	A JSON-pointer reference to a simulation period bound.
`DatedRaster`	One raster valid from `from` to `to` (both inclusive, whole months).
`DirectoryRasterSeries`	One raster per step, named `<files_prefix>` plus the PCRaster 8.3 step suffix.
`InitialSoilConditions`	Create a new model by parsing and validating input data from keyword arguments.
`LookupTables`	Create a new model by parsing and validating input data from keyword arguments.
`Metadata`	Free-form description of the simulation (issue #182).
`ModelConfigurationFileV1`	The configuration file, format 1.0.
`MonthlyRaster`	Create a new model by parsing and validating input data from keyword arguments.
`MonthlyRasterSeries`	Twelve rasters repeated every year, optionally replaced from `yearly_from` on.
`RasterFormat`
`RasterInfo`	Create a new model by parsing and validating input data from keyword arguments.
`RasterSeries`	Create a new model by parsing and validating input data from keyword arguments.
`RasterSeriesOutput`	Create a new model by parsing and validating input data from keyword arguments.
`Rasters`	Create a new model by parsing and validating input data from keyword arguments.
`SimulationOutput`	Create a new model by parsing and validating input data from keyword arguments.
`SimulationPeriod`	ISO dates; `finish` is the last simulated month.
`TimeSeriesFormat`
`TimeSeriesOutput`	Time series selection.