gwgen evaluate¶

Evaluate the experiment

usage: gwgen evaluate [-h] [-s str or list of str] [-ido str] [-f str]
                      [-to-db] [-to-csv] [-db str] [-nr [task1,task2,...]]
                      [-complete]
                      {output,prepare,ks,quality,quants} ...

Optional Arguments

`-s, --stations`	either a list of stations to use or a filename containing a 1-row table with stations
`-ido, --other_id`
	Use the configuration from another experiment
`-f, --from`	Determine where to get the data from. If `scratch`, the data will be calculated from the raw data. If `file`, the data will be loaded from a file, if `db`, the data will be loaded from a postgres database (Note that the `database` argument must be provided!).
`-to-db`	Save the data into a postgresql database (Note that the `database` argument must be provided!)
`-to-csv`	Save the data into a csv file
`-db, --database`
	The name of a postgres data base to write the data to
`-nr=False, --norun=False`
	If set without value or “all” or a number different from 0, the data is set up and the configuration of the experiment is not affected. Otherwise it can be a comma separated list of parameterization tasks for which to only setup the data
`-complete=False`
	If True, setup and run all possible tasks

Sub-commands:

output

The default configuration for TaskBase instances. See also the :attr:`TaskBase.default_config` attribute

usage: gwgen evaluate output [-h] [-ido str]
                             [-f { 'scratch' | 'file' | 'db' | None }]
                             [-to-csv] [-to-db] [-rm] [-sf]

Optional Arguments

`-ido, --other_id`
	Use the configuration from another experiment

Setup arguments

`-f, --from`	The method how to setup the instance either from ``’scratch’`` To set up the task from the raw data ``’file’`` Set up the task from an existing file ``’db’`` Set up the task from a database ``None`` If the file name of this this task exists, use this one, otherwise a database is provided, use this one, otherwise go from scratch Possible choices: scratch, file, db
`-to-csv=False`	If True, the data at setup will be written to a csv file
`-to-db=False`	If True, the data at setup will be written to into a database
`-rm=False, --remove=False`
	If True and the old data file already exists, remove before writing to it
`-sf=False, --skip-filtering=False`
	If True, skip the filtering for the correct stations in the datafile

prepare

The default configuration for :class:`EvaluationPreparation` instances. See also the :attr:`EvaluationPreparation.default_config` attribute

usage: gwgen evaluate prepare [-h] [-ido str]
                              [-fr { 'scratch' | 'file' | 'db' | None }]
                              [-raw2db] [-raw2csv] [-r str] [-i str]
                              [-f { 'scratch' | 'file' | 'db' | None }]
                              [-to-csv] [-to-db] [-rm] [-sf]

Optional Arguments

`-ido, --other_id`
	Use the configuration from another experiment

Setup arguments

`-fr, --raw-from`
	The method how to setup the raw data from GHCN and EECRA ``’scratch’`` To set up the task from the raw data ``’file’`` Set up the task from an existing file ``’db’`` Set up the task from a database ``None`` If the file name of this this task exists, use this one, otherwise a database is provided, use this one, otherwise go from scratch
`-raw2db=False`	If True, the raw data from GHCN and EECRA is stored in a postgres database
`-raw2csv=False`	If True, the raw data from GHCN and EECRA is stored in a csv file
`-r, --reference`
	The path of the file where to store the reference data. If None and not already set in the configuration, it will default to ``’evaluation/reference.csv’``
`-i, --input`	The path of the file where to store the model input. If None, and not already set in the configuration, it will default to ``’inputdir/input.csv’`` where inputdir is the path to the input directory (by default, input in the experiment directory)
`-f, --from`	The method how to setup the instance either from ``’scratch’`` To set up the task from the raw data ``’file’`` Set up the task from an existing file ``’db’`` Set up the task from a database ``None`` If the file name of this this task exists, use this one, otherwise a database is provided, use this one, otherwise go from scratch Possible choices: scratch, file, db
`-to-csv=False`	If True, the data at setup will be written to a csv file
`-to-db=False`	If True, the data at setup will be written to into a database
`-rm=False, --remove=False`
	If True and the old data file already exists, remove before writing to it
`-sf=False, --skip-filtering=False`
	If True, skip the filtering for the correct stations in the datafile

ks

The default configuration for :class:`KSEvaluation` instances. See also the :attr:`KSEvaluation.default_config` attribute

usage: gwgen evaluate ks [-h] [-ido str] [-nr] [-n variable [variable ...]]
                         [-tw] [-f { 'scratch' | 'file' | 'db' | None }]
                         [-to-csv] [-to-db] [-rm] [-sf] [-o str]

Optional Arguments

`-ido, --other_id`
	Use the configuration from another experiment

Setup arguments

`-n, --names`	The list of variables use for calculation. If None, all variables will be used Possible choices: prcp, tmin, tmax, mean_cloud, wind
`-tw=False, --transform-wind=False`
	If True, the square root of the wind is evaluated (as this is also simulated in the weather generator)
`-f, --from`	The method how to setup the instance either from ``’scratch’`` To set up the task from the raw data ``’file’`` Set up the task from an existing file ``’db’`` Set up the task from a database ``None`` If the file name of this this task exists, use this one, otherwise a database is provided, use this one, otherwise go from scratch Possible choices: scratch, file, db
`-to-csv=False`	If True, the data at setup will be written to a csv file
`-to-db=False`	If True, the data at setup will be written to into a database
`-rm=False, --remove=False`
	If True and the old data file already exists, remove before writing to it
`-sf=False, --skip-filtering=False`
	If True, skip the filtering for the correct stations in the datafile

Run arguments

`-nr=False, --no-rounding=False`
	Do not round the simulation to the infered precision of the reference. The inferred precision is the minimum difference between two values with in the entire data
`-o, --plot-output`
	An alternative path to use for the PDF file of the plot

quality

Estimate simulation quality using ks and quantile evaluation

usage: gwgen evaluate quality [-h] [-q q1[,q1[,q2[,...]]]] [-ido str]

Optional Arguments

`-q, --quantiles`
	The quantiles to use for the quality analysis
`-ido, --other_id`
	Use the configuration from another experiment

quants

The default configuration for :class:`KSEvaluation` instances. See also the :attr:`KSEvaluation.default_config` attribute

usage: gwgen evaluate quants [-h] [-ido str] [-nr]
                             [-n variable [variable ...]] [-tw]
                             [-q f1[,f21[-f22[-f23]]]]
                             [-f { 'scratch' | 'file' | 'db' | None }]
                             [-to-csv] [-to-db] [-rm] [-sf] [-o str]
                             [-onc str] [-op str] [-np] [-p str]

Optional Arguments

`-ido, --other_id`
	Use the configuration from another experiment

Setup arguments

`-n, --names`	The list of variables use for calculation. If None, all variables will be used Possible choices: prcp, tmin, tmax, mean_cloud, wind
`-tw=False, --transform-wind=False`
	If True, the square root of the wind is evaluated (as this is also simulated in the weather generator)
`-f, --from`	The method how to setup the instance either from ``’scratch’`` To set up the task from the raw data ``’file’`` Set up the task from an existing file ``’db’`` Set up the task from a database ``None`` If the file name of this this task exists, use this one, otherwise a database is provided, use this one, otherwise go from scratch Possible choices: scratch, file, db
`-to-csv=False`	If True, the data at setup will be written to a csv file
`-to-db=False`	If True, the data at setup will be written to into a database
`-rm=False, --remove=False`
	If True and the old data file already exists, remove before writing to it
`-sf=False, --skip-filtering=False`
	If True, skip the filtering for the correct stations in the datafile

Run arguments

`-nr=False, --no-rounding=False`
	Do not round the simulation to the infered precision of the reference. The inferred precision is the minimum difference between two values with in the entire data
`-q=[1, 5, 10, 25, 50, 75, 90, 95, 99, 100], --quantiles=[1, 5, 10, 25, 50, 75, 90, 95, 99, 100]`
	The quantiles to use for calculating the percentiles. A comma (``’,’``) separated string. A single value in this string represents one number, ranges can also be used via a separation by comma (``’-‘``). Hence, ``‘2009,2012-2015’`` will be converted to ``[2009,2012, 2013, 2014]`` and ``2009,2012-2015-2`` to ``[2009, 2012, 2015]``.
`-o, --plot-output`
	An alternative path to use for the PDF file of the plot
`-onc, --nc-output`
	An alternative path (or multiples depending on the task) to use for the netCDF file of the plot data
`-op, --project-output`
	An alternative path to use for the psyplot project file of the plot
`-np=False, --new-project=False`
	If True, a new project will be created even if a file in `project_output` exists already
`-p, --project`	The path to a psyplot project file to use for this parameterization

gwgen evaluate¶

gwgen

Navigation

Related Topics

This Page