Command Line API Reference

• gwgen setup
• gwgen compile
• gwgen init
• gwgen set-value
• gwgen get-value
• gwgen del-value
• gwgen info
• gwgen unarchive
• gwgen configure
• gwgen preproc
• gwgen param
• gwgen run
• gwgen evaluate
• gwgen bias
• gwgen sens
• gwgen archive
• gwgen remove

The main function for parsing global arguments

usage: gwgen [-h] [-id str] [-l] [-n] [-v] [-vl str or int] [-nm] [-E]
             {setup,compile,init,set-value,get-value,del-value,info,unarchive,configure,preproc,param,run,evaluate,bias,sens,archive,remove}
             ...

Optional Arguments

-id, --experiment
	experiment: str The id of the experiment to use. If the `init` argument is called, the `new` argument is automatically set. Otherwise, if not specified differently, the last created experiment is used.
-l=False, --last=False
	If True, the last experiment is used
-n=False, --new=False
	If True, a new experiment is created
-v=False, --verbose=False
	Increase the verbosity level to DEBUG. See also `verbosity_level` for a more specific determination of the verbosity
-vl, --verbosity-level
	The verbosity level to use. Either one of ``’DEBUG’, ‘INFO’, ‘WARNING’, ‘ERROR’`` or the corresponding integer (see pythons logging module)
-nm=False, --no-modification=False
	If True/set, no modifications in the configuration files will be done
-E=False, --match=False
	If True/set, interprete `experiment` as a regular expression (regex) und use the matching experiment

Sub-commands:

setup

Perform the initial setup for the model

usage: gwgen setup [-h] [-p str] [-link] [-src str] [-c str] str

Required Arguments

str	The path to the root directory where the experiments, etc. will be stored

Optional Arguments

-p, --projectname
	The name of the project that shall be initialized at `root_dir`. A new directory will be created namely ``root_dir + ‘/’ + projectname``
-link=False	If set, the source files are linked to the original ones instead of copied link: bool If set, the source files are linked to the original ones instead of copied
-src, --src-project
	Another model name to use the source model files from
-c, --compiler	The path to the compiler to use. If None, the global compiler option is used

compile

Compile the model

usage: gwgen compile [-h] [-p str]

Optional Arguments

-p, --projectname
	The name of the project. If None, use the last one or the one specified by the current experiment

init

Initialize a new experiment

usage: gwgen init [-h] [-p str] [-d str]

Optional Arguments

-p, --projectname
	The name of the project that shall be used. If None, the last one created will be used
-d, --description
	A short summary of the experiment

set-value

Set a value in the configuration

usage: gwgen set-value [-h] [-a] [-P] [-g] [-p str] [-b str] [-dt str]
                       level0.level1.level...=value
                       [level0.level1.level...=value ...]

Required Arguments

level0.level1.level...=value
	The key-value pairs to set. If the configuration goes some levels deeper, keys may be separated by a ``’.’`` (e.g. ``’namelists.weathergen’``). Hence, to insert a ``’,’``, it must be escaped by a preceeding ``’‘``.

Optional Arguments

-a=False, --all=False
	If True/set, the information on all experiments are printed
-P=False, --on-projects=False
	If set, show information on the projects rather than the experiment
-g=False, --globally=False
	If set, show the global configuration settings
-p, --projectname
	The name of the project that shall be used. If provided and `on_projects` is not True, the information on all experiments for this project will be shown
-b=, --base=	A base string that shall be put in front of each key in `values` to avoid typing it all the time
-dt, --dtype	The name of the data type or a data type to cast the value to Possible choices: ArithmeticError, AssertionError, AttributeError, BaseException, BufferError, BytesWarning, DeprecationWarning, EOFError, Ellipsis, EnvironmentError, Exception, False, FloatingPointError, FutureWarning, GeneratorExit, IOError, ImportError, ImportWarning, IndentationError, IndexError, KeyError, KeyboardInterrupt, LookupError, MemoryError, NameError, None, NotImplemented, NotImplementedError, OSError, OverflowError, PendingDeprecationWarning, ReferenceError, RuntimeError, RuntimeWarning, StandardError, StopIteration, SyntaxError, SyntaxWarning, SystemError, SystemExit, TabError, True, TypeError, UnboundLocalError, UnicodeDecodeError, UnicodeEncodeError, UnicodeError, UnicodeTranslateError, UnicodeWarning, UserWarning, ValueError, Warning, ZeroDivisionError, __debug__, __doc__, __import__, __name__, __package__, abs, all, any, apply, basestring, bin, bool, buffer, bytearray, bytes, callable, chr, classmethod, cmp, coerce, compile, complex, copyright, credits, delattr, dict, dir, divmod, enumerate, eval, execfile, exit, file, filter, float, format, frozenset, getattr, globals, hasattr, hash, help, hex, id, input, int, intern, isinstance, issubclass, iter, len, license, list, locals, long, map, max, memoryview, min, next, object, oct, open, ord, pow, print, property, quit, range, raw_input, reduce, reload, repr, reversed, round, set, setattr, slice, sorted, staticmethod, str, sum, super, tuple, type, unichr, unicode, vars, xrange, zip

get-value

Get one or more values in the configuration

usage: gwgen get-value [-h] [-ep] [-pp] [-a] [-P] [-g] [-p str] [-nf] [-k]
                       [-b str] [-arc]
                       level0.level1.level... [level0.level1.level... ...]

Required Arguments

level0.level1.level...
	A list of keys to get the values of. If the key goes some levels deeper, keys may be separated by a ``’.’`` (e.g. ``’namelists.weathergen’``). Hence, to insert a ``’,’``, it must be escaped by a preceeding ``’‘``.

Optional Arguments

-ep=False, --exp-path=False
	If True/set, print the filename of the experiment configuration
-pp=False, --project-path=False
	If True/set, print the filename on the project configuration
-a=False, --all=False
	If True/set, the information on all experiments are printed
-P=False, --on-projects=False
	If set, show information on the projects rather than the experiment
-g=False, --globally=False
	If set, show the global configuration settings
-p, --projectname
	The name of the project that shall be used. If provided and `on_projects` is not True, the information on all experiments for this project will be shown
-nf=False, --no-fix=False
	If set, paths are given relative to the root directory of the project
-k=False, --only-keys=False
	If True, only the keys of the given dictionary are printed
-b=, --base=	A base string that shall be put in front of each key in `values` to avoid typing it all the time
-arc=False, --archives=False
	If True, print the archives and the corresponding experiments for the specified project

del-value

Delete a value in the configuration

usage: gwgen del-value [-h] [-a] [-P] [-g] [-p str] [-b str] [-dtype DTYPE]
                       level0.level1.level... [level0.level1.level... ...]

Required Arguments

level0.level1.level...
	A list of keys to be deleted. If the key goes some levels deeper, keys may be separated by a ``’.’`` (e.g. ``’namelists.weathergen’``). Hence, to insert a ``’,’``, it must be escaped by a preceeding ``’‘``.

Optional Arguments

-a=False, --all=False
	If True/set, the information on all experiments are printed
-P=False, --on-projects=False
	If set, show information on the projects rather than the experiment
-g=False, --globally=False
	If set, show the global configuration settings
-p, --projectname
	The name of the project that shall be used. If provided and `on_projects` is not True, the information on all experiments for this project will be shown
-b=, --base=	A base string that shall be put in front of each key in `values` to avoid typing it all the time
-dtype	Undocumented

info

Print information on the experiments

usage: gwgen info [-h] [-ep] [-pp] [-gp] [-cp] [-a] [-nf] [-P] [-g] [-p str]
                  [-k] [-arc]

Optional Arguments

-ep=False, --exp-path=False
	If True/set, print the filename of the experiment configuration
-pp=False, --project-path=False
	If True/set, print the filename on the project configuration
-gp=False, --global-path=False
	If True/set, print the filename on the global configuration
-cp=False, --config-path=False
	If True/set, print the path to the configuration directory
-a=False, --all=False
	If True/set, the information on all experiments are printed
-nf=False, --no-fix=False
	If set, paths are given relative to the root directory of the project
-P=False, --on-projects=False
	If set, show information on the projects rather than the experiment
-g=False, --globally=False
	If set, show the global configuration settings
-p, --projectname
	The name of the project that shall be used. If provided and `on_projects` is not True, the information on all experiments for this project will be shown
-k=False, --only-keys=False
	If True, only the keys of the given dictionary are printed
-arc=False, --archives=False
	If True, print the archives and the corresponding experiments for the specified project

unarchive

Extract archived experiments

usage: gwgen unarchive [-h] [-ids exp1,[exp2[,...]]] [exp1,[exp2[,...]]] ...]]
                       [-f str] [-a] [-pd] [-P] [-d str] [-p str]
                       [-fmt { 'gztar' | 'bztar' | 'tar' | 'zip' }] [--force]

Optional Arguments

-ids, --experiments
	The experiments to extract. If None the current experiment is used
-f, --file	The path to an archive to extract the experiments from. If None, we assume that the path to the archive has been stored in the configuration when using the :meth:`archive` command
-a=False, --all=False
	If True, archives are extracted completely, not only the experiment (implies ``project_data = True``)
-pd=False, --project-data=False
	If True, the data for the project is extracted as well
-P=False, --replace-project-config=False
	If True and the project does already exist in the configuration, it is updated with what is stored in the archive
-d, --root	An alternative root directory to use. Otherwise the experiment will be exctracted to 1. the root directory specified in the configuration files (if the project exists in it) and `replace_project_config` is False 2. the root directory as stored in the archive
-p, --projectname
	The projectname to use. If None, use the one specified in the archive
-fmt	The format of the archive. If None, it is inferred
--force=False	If True, force to overwrite the configuration of all experiments from what is stored in `archive`. Otherwise, the configuration of the experiments in `archive` are only used if missing in the current configuration

configure

Configure the projects and experiments

usage: gwgen configure [-h] [-u str or dict] [-max int] [-d str] [-db str]
                       [-user str] [-host str] [-port int] [-chunksize int]
                       [-c str] [-g] [-p] [-i str] [-f str] [-s]
                       [-n int or 'all'] [-update-from str]

Optional Arguments

-u, --update-nml
	A python dict or path to a namelist to use for updating the namelist of the experiment
-max, --max-stations
	The maximum number of stations to process in one parameterization process. Does automatically impact global settings
-d, --datadir	Path to the data directory to use (impacts the project configuration)
-db, --database
	The name of a postgres data base to write the data to
-user	The username to use when logging into the database
-host	the host which runs the database server
-port	The port to use to log into the the database
-chunksize	The chunksize to use for the parameterization and evaluation
-c, --compiler	The path to the fortran compiler to use
-g=False, --globally=False
	If True/set, the configuration are applied globally (already existing and configured experiments are not impacted)
-p=False, --project=False
	Apply the configuration on the entire project instance instead of only the single experiment (already existing and configured experiments are not impacted)
-i, --ifile	The input file for the project. Must be a netCDF file with population data
-f, --forcing	The input file for the project containing variables with population evolution information. Possible variables in the netCDF file are *movement* containing the number of people to move and *change* containing the population change (positive or negative)
-s=False, --serial=False
	Do the parameterization always serial (i.e. not in parallel on multiple processors). Does automatically impact global settings
-n, --nprocs	Maximum number of processes to when making the parameterization in parallel. Does automatically impact global settings and disables `serial`
-update-from	Path to a yaml configuration file to update the specified configuration with it

preproc

Preprocess the data

usage: gwgen preproc [-h] {select,cloud,test} ...

Sub-commands:

select

Select stations based upon a regular grid

usage: gwgen preproc select [-h] [-g str] [-og str] [-os str] [-k str]
                            [-ok str] [-gdb str] [-sdb str] [-nc]
                            [-f { 'scratch' | 'file' | 'db' }]
                            [-d { 'single' | 'all' }]

Optional Arguments

-g, --grid	The path to a csv-file containing a lat and a lon column with the information on the centers of the grid. If None, `igrid_key` must not be None and point to a key in the configuration (either the one of the experiment, or the project, or the global configuration) specifying the path
-og, --grid-output
	The path to the csv-file where to store the mapping from grid lat-lon to station id.
-os, --stations-output
	The path to the csv-file where to store the mapping from station to grid center point
-k, --igrid-key
	The key in the configuration where to store the path of the `grid` input file
-ok, --grid-key
	The key in the configuration where to store the name of the `grid_output` file.
-gdb, --grid-db
	The name of a data table to store the data of `stations_output` in
-sdb, --stations-db
	The name of a data table to store the data for `stations_output` in
-nc=False, --no-prcp-check=False
	If True, we will not check for the values between 0.1 and 1.0 for precipitation and save the result in the ``’best’`` column
-f, --from	The setup method for the daily data for the prcp check
-d, --download	Handles how to manage missing files for the prcp check. If None (default), an warning is printed and the file is ignored, if ``’single’``, the missing file is downloaded, if ``’all’``, the entire tarball is downloaded (strongly not recommended for this function) Possible choices: single, all

cloud

Extract the inventory of EECRA stations

usage: gwgen preproc cloud [-h] [-mf int] {eecra_inventory,eecra_ghcn_map} ...

Optional Arguments

-mf, --max-files
	The maximum number of files to process during one process. If None, it is determined by the global ``’max_stations’`` key

Sub-commands:

eecra_inventory

Default config for :class:`CloudInventory`

usage: gwgen preproc cloud eecra_inventory [-h] [-ido str]
                                           [-xstall bool or 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

-xstall=True	If True (default), download the XSTALL file from http://cdiac.ornl.gov/ftp/ndp026c/XSTALL. This file contains some estimates of station longitude and latitude. If ``False`` or empty string, the file is not used, otherwise, if set with a string, it is interpreted as the path to the local file
-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

eecra_ghcn_map

Default config for :class:`CloudGHCNMap`

usage: gwgen preproc cloud eecra_ghcn_map [-h] [-ido str] [-md float]
                                          [-to-csv] [-rm] [-sf]

Optional Arguments

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

Setup arguments

-md=1000.0, --max-distance=1000.0
	The maximum distance in meters for which we consider two stations as equal (Default: 1000m)
-to-csv=False	If True, the data at setup will be written to a csv file
-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

test

Create a test sample for the given GHCN stations

usage: gwgen preproc test [-h] [-nc] [-re float] [-a] str str or list of str

Required Arguments

str	The path to the directory containing the test files from Github
str or list of str
	either a list of GHCN stations to use or a filename containing a 1-row table with GHCN stations

Optional Arguments

-nc=False, --no-cloud=False
	If True, no cloud stations are extracted
-re=0, --reduce-eecra=0
	The percentage by which to reduce the EECRA data
-a=False, --keep-all=False
	If True all years of the EECRA data are used. Otherwise, only the years with complete temperature and cloud are kept. Note that this has only an effect if `reduce_eecra` is not 0

param

Parameterize the experiment

usage: gwgen param [-h] [-complete] [-s str or list of str] [-ido str]
                   [-f str] [-to-db] [-to-csv] [-db str]
                   [-nr [task1,task2,...]]
                   {hourly_cloud,daily_cloud,day,month,yearly_cmonth,monthly_cloud,cmonthly_wind,yearly_cmonthly_wind,cday,temp,cdaily_cloud,cmonth,markov,cmonthly_cloud,cloud,yearly_cdaily_cloud,corr,yearly_cmonthly_cloud,yearly_cday,prcp,wind}
                   ...

Optional Arguments

-complete=False
	If True, setup and run all possible tasks
-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

Sub-commands:

hourly_cloud

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

usage: gwgen param hourly_cloud [-h] [-ido str] [-at {ghcn,eecra,files}]
                                [-f { 'scratch' | 'file' | 'db' | None }]
                                [-to-csv] [-to-db] [-rm] [-sf]

Optional Arguments

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

Setup arguments

-at=ghcn, --args-type=ghcn
	The type of the stations. One of ghcn Stations are GHCN ids eecra Stations are EECRA station numbers files Arguments are paths to raw EECRA files Default: ghcn Possible choices: ghcn, eecra, files
-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

daily_cloud

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

usage: gwgen param daily_cloud [-h] [-ido str] [-at {ghcn,eecra,files}]
                               [-f { 'scratch' | 'file' | 'db' | None }]
                               [-to-csv] [-to-db] [-rm] [-sf]

Optional Arguments

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

Setup arguments

-at=ghcn, --args-type=ghcn
	The type of the stations. One of ghcn Stations are GHCN ids eecra Stations are EECRA station numbers files Arguments are paths to raw EECRA files Default: ghcn Possible choices: ghcn, eecra, files
-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

day

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

usage: gwgen param day [-h] [-ido str] [-d { 'single' | 'all' | None }]
                       [-f { 'scratch' | 'file' | 'db' | None }] [-to-csv]
                       [-to-db] [-rm] [-sf]

Optional Arguments

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

Setup arguments

-d, --download	What to do if a stations file is missing. The default is ``None`` which raises an Error. Otherwise, if ``’single’``, download the missing file from ftp://ftp.ncdc.noaa.gov/pub/data/ghcn/daily/all/{}. If ``’all’`` the entire tarball is downloaded from ftp://ftp.ncdc.noaa.gov/pub/data/ghcn/daily/ghcnd_all.tar.gz Possible choices: single, all
-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

month

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

usage: gwgen param month [-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

yearly_cmonth

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

usage: gwgen param yearly_cmonth [-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

monthly_cloud

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

usage: gwgen param monthly_cloud [-h] [-ido str] [-at {ghcn,eecra,files}]
                                 [-f { 'scratch' | 'file' | 'db' | None }]
                                 [-to-csv] [-to-db] [-rm] [-sf]

Optional Arguments

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

Setup arguments

-at=ghcn, --args-type=ghcn
	The type of the stations. One of ghcn Stations are GHCN ids eecra Stations are EECRA station numbers files Arguments are paths to raw EECRA files Default: ghcn Possible choices: ghcn, eecra, files
-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

cmonthly_wind

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

usage: gwgen param cmonthly_wind [-h] [-ido str] [-at {ghcn,eecra,files}]
                                 [-f { 'scratch' | 'file' | 'db' | None }]
                                 [-to-csv] [-to-db] [-rm] [-sf]

Optional Arguments

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

Setup arguments

-at=ghcn, --args-type=ghcn
	The type of the stations. One of ghcn Stations are GHCN ids eecra Stations are EECRA station numbers files Arguments are paths to raw EECRA files Default: ghcn Possible choices: ghcn, eecra, files
-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

yearly_cmonthly_wind

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

usage: gwgen param yearly_cmonthly_wind [-h] [-ido str] [-at {ghcn,eecra}]
                                        [-f { 'scratch' | 'file' | 'db' | None }]
                                        [-to-csv] [-to-db] [-rm] [-sf]

Optional Arguments

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

Setup arguments

-at=ghcn, --args-type=ghcn
	The type of the stations. One of ghcn Stations are GHCN ids eecra Stations are EECRA station numbers Default: ghcn Possible choices: ghcn, eecra
-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

cday

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

usage: gwgen param cday [-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

temp

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

usage: gwgen param temp [-h] [-ido str] [-cutoff int]
                        [-tmin-range1 floats with length 2 floats with length 2]
                        [-tmin-range2 floats with length 2 floats with length 2]
                        [-tmax-range1 floats with length 2 floats with length 2]
                        [-tmax-range2 floats with length 2 floats with length 2]
                        [-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
-cutoff=10	The minimum number of values that is required for fitting the standard deviation. Default: 10
-tmin-range1=[-50, -40]
	The ranges ``[vmin, vmax]`` to use for the extrapolation of minimum temperatures standard deviation below 0. The fit will be used for all points below the given ``vmax``. Default: [-50, -40]
-tmin-range2=[25, 30]
	The ranges ``[vmin, vmax]`` to use for the extrapolation of minimum temperatures standard deviation above 0. The fit will be used for all points above the given ``vmin``. Default: [25, 30]
-tmax-range1=[-40, -30]
	The ranges ``[vmin, vmax]`` to use for the extrapolation of maximum temperatures standard deviation below 0. The fit will be used for all points below the given ``vmax``. Default: [-40, -30]
-tmax-range2=[35, 45]
	The ranges ``[vmin, vmax]`` to use for the extrapolation of maximum temperatures standard deviation above 0. The fit will be used for all points above the given ``vmin``. Default: [35, 45]

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

Run arguments

-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

cdaily_cloud

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

usage: gwgen param cdaily_cloud [-h] [-ido str] [-at {ghcn,eecra,files}]
                                [-f { 'scratch' | 'file' | 'db' | None }]
                                [-to-csv] [-to-db] [-rm] [-sf]

Optional Arguments

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

Setup arguments

-at=ghcn, --args-type=ghcn
	The type of the stations. One of ghcn Stations are GHCN ids eecra Stations are EECRA station numbers files Arguments are paths to raw EECRA files Default: ghcn Possible choices: ghcn, eecra, files
-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

cmonth

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

usage: gwgen param cmonth [-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

markov

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

usage: gwgen param markov [-h] [-ido str]
                          [-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

-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

-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

cmonthly_cloud

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

usage: gwgen param cmonthly_cloud [-h] [-ido str] [-at {ghcn,eecra,files}]
                                  [-f { 'scratch' | 'file' | 'db' | None }]
                                  [-to-csv] [-to-db] [-rm] [-sf]

Optional Arguments

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

Setup arguments

-at=ghcn, --args-type=ghcn
	The type of the stations. One of ghcn Stations are GHCN ids eecra Stations are EECRA station numbers files Arguments are paths to raw EECRA files Default: ghcn Possible choices: ghcn, eecra, files
-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

cloud

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

usage: gwgen param cloud [-h] [-ido str] [-at {ghcn,eecra}]
                         [-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

-at=ghcn, --args-type=ghcn
	The type of the stations. One of ghcn Stations are GHCN ids eecra Stations are EECRA station numbers Default: ghcn Possible choices: ghcn, eecra
-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

-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

yearly_cdaily_cloud

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

usage: gwgen param yearly_cdaily_cloud [-h] [-ido str] [-at {ghcn,eecra}]
                                       [-f { 'scratch' | 'file' | 'db' | None }]
                                       [-to-csv] [-to-db] [-rm] [-sf]

Optional Arguments

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

Setup arguments

-at=ghcn, --args-type=ghcn
	The type of the stations. One of ghcn Stations are GHCN ids eecra Stations are EECRA station numbers Default: ghcn Possible choices: ghcn, eecra
-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

corr

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

usage: gwgen param corr [-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

yearly_cmonthly_cloud

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

usage: gwgen param yearly_cmonthly_cloud [-h] [-ido str] [-at {ghcn,eecra}]
                                         [-f { 'scratch' | 'file' | 'db' | None }]
                                         [-to-csv] [-to-db] [-rm] [-sf]

Optional Arguments

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

Setup arguments

-at=ghcn, --args-type=ghcn
	The type of the stations. One of ghcn Stations are GHCN ids eecra Stations are EECRA station numbers Default: ghcn Possible choices: ghcn, eecra
-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

yearly_cday

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

usage: gwgen param yearly_cday [-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

prcp

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

usage: gwgen param prcp [-h] [-ido str] [-t float] [-t2c float [float ...]]
                        [-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

-t2c=[5, 7.5, 10, 12.5, 15, 17.5, 20], --threshs2compute=[5, 7.5, 10, 12.5, 15, 17.5, 20]
	The thresholds to compute during the setup of the data
-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

-t=5.0, --thresh=5.0
	The threshold to use for the configuration. Default: 5.0
-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

wind

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

usage: gwgen param wind [-h] [-ido str] [-at {ghcn,eecra}]
                        [-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

-at=ghcn, --args-type=ghcn
	The type of the stations. One of ghcn Stations are GHCN ids eecra Stations are EECRA station numbers Default: ghcn Possible choices: ghcn, eecra
-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

-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

run

Run the experiment

usage: gwgen run [-h] [-i str] [-o str] [-od str] [-wd str] [-r]

Optional Arguments

-i, --ifile	The path to the input file. If None, it is assumed that it is stored in the ``’input’`` key in the experiment configuration
-o, --ofile	The path to the output file. If None, it is assumed that it is stored in the ``’input’`` key in the experiment configuration or it will be stored in ``’odir/exp_id.csv’``. The output directory ``’odir’`` is determined by the `odir` parameter
-od, --odir	The path to the output directory. If None and not already saved in the configuration, it will default to ``’experiment_dir/outdata’``
-wd, --work-dir
	The path to the work directory where the binaries are copied to.
-r=False, --remove=False
	If True, the `work_dir` will be removed if it already exists

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

bias

Perform a bias correction for the data

usage: gwgen bias [-h] [-k] [-q f1[,f21[-f22[-f23]]]] [-ne] [-np]
                  {wind,tmin} ...

Optional Arguments

-k=False, --keep=False
	If not True, the experiment configuration files are not modified. Otherwise the `quants` section is kept for the given quantiles
-q=[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99], --quantiles=[1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12, 13, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 27, 28, 29, 30, 31, 32, 33, 34, 35, 36, 37, 38, 39, 40, 41, 42, 43, 44, 45, 46, 47, 48, 49, 50, 51, 52, 53, 54, 55, 56, 57, 58, 59, 60, 61, 62, 63, 64, 65, 66, 67, 68, 69, 70, 71, 72, 73, 74, 75, 76, 77, 78, 79, 80, 81, 82, 83, 84, 85, 86, 87, 88, 89, 90, 91, 92, 93, 94, 95, 96, 97, 98, 99]
	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]``.
-ne=False, --no-evaluation=False
	If True, the existing evaluation in the configuration is used for the bias correction
-np=False, --new-project=False
	If True, a new project will be created even if a file in `project_output` exists already

Sub-commands:

wind

Perform a bias correction for the data

usage: gwgen bias wind [-h] [-np] [-po str]

Optional Arguments

-np=False, --new-project=False
	If True, a new project will be created even if a file in `project_output` exists already
-po, --plot-output
	The name of the output file. If not specified, it defaults to `<exp_dir>/postproc/<vname>_bias_correction.pdf`

tmin

Perform a bias correction based on percentile and a polynomial fit

usage: gwgen bias tmin [-h] [-np] [-po str] [-deg int]

Optional Arguments

-np=False, --new-project=False
	If True, a new project will be created even if a file in `project_output` exists already
-po, --plot-output
	The name of the output file. If not specified, it defaults to `<exp_dir>/postproc/<vname>_bias_correction.pdf`
-deg=3	The degree of the fittet polynomial

sens

Perform a sensitivity analysis on the given parameters This function performs a sensitivity analysis on the current experiment. It creates a new project and uses the evaluation and parameterization of the current experiment to get information on the others

usage: gwgen sens [-h] {setup,compile,init,run,evaluate,plot,remove} ...

Sub-commands:

setup

Set up the experiments for the project

usage: gwgen sens setup [-h] [-root-dir str] [-p str] [-link] [-nm]

Optional Arguments

-root-dir	The path to the root directory where the experiments, etc. will be stored. If not given, a new directory will be created at the same location as the original project
-p, --projectname
	The name of the project that shall be initialized at `root_dir`. A new directory will be created namely ``root_dir + ‘/’ + projectname``. If not given, defaults to ``’sensitivity_<id>’`` where ``’<id>’`` is the experiment id
-link=True	If set, the source files are linked to the original ones instead of copied
-nm=False, --no-move=False
	If True, the project in the configuration files is not moved to the position right before the configuration of the current project

compile

Compile the sensitivity analysis model

usage: gwgen sens compile [-h]

init

Initialize the experiments for the sensitivity analysis

usage: gwgen sens init [-h] [-nml nml_key=f1[,f21[-f22[-f23]]]
                       [nml_key=f1[,f21[-f22[-f23]]] ...]] [-id str] [-prep]
                       [-use-param] [-nm]

Optional Arguments

-nml, --namelist
	A list from namelist parameters and their values to use. 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]``. You can also use ``’<i>err’`` in the list which will be interpreted as ``’<i>’``-times the error from the parameterization.
-id, --experiment
	The base experiment name to use. Should somehow contain a number which will be increased for each experiment. If None, it will default to ``’<id>_sens0’``
-prep=False, --run-prepare=False
	If True or no ``’input’`` key exists for the experiment, the ``’prepare’`` evaluation task is run to get the reference data. Otherwise, if False and the ``’input’`` key does not exist, the specified file is used
-use-param=False
	If True/set and the parameterization is required, use the parameterization of the original experiment
-nm=False, --no-move=False
	If True, the experiment in the configurations are not moved to the position right before the configuration of the current experiment

run

Run the analysis

usage: gwgen sens run [-h] [-ids id1,id2,...] [-rm]

Optional Arguments

-ids, --experiments
	The experiments to use. If None, all experiments are used
-rm=False, --remove=False
	If True, the `work_dir` will be removed if it already exists

evaluate

Evaluate the experiments of the sensitivity analysis

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

Optional Arguments

-ids, --experiments
	The experiments to use. If None, all experiments are used
-loop=False, --loop-exps=False
	If True the experiments of the sensitivity analysis are called one after each other. Otherwise they are called in parallel, each on a single core (unless the the serial option in the global configuration is set)
-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:

ks

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

usage: gwgen sens 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 sens 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 sens 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

plot

Plot the result of the sensitivity analysis 2 different plots are made for each variable and quality indicator: 1. 1d plots with the indicator on the y-axis and the namelist parameter on the x-axis 2. 2d plots with one indicator on the x-axis and another on the y-axis for each possible combination You can disable one of the plot types via the `only_1d` and `only_2d` parameter.

usage: gwgen sens plot [-h] [-i indicator[,indicator[,...]]]
                       [-n variable,[variable[,...]]] [-meta <yaml-file>]
                       {plot1d,plot2d} ...

Optional Arguments

-i=['rsquared', 'slope', 'ks', 'quality'], --indicators=['rsquared', 'slope', 'ks', 'quality']
	The name of the indicators from the `quality` evaluation task
-n=['prcp', 'tmin', 'tmax', 'mean_cloud', 'wind'], --names=['prcp', 'tmin', 'tmax', 'mean_cloud', 'wind']
	The name(s) of the variable(s) to plot
-meta	Alternative meta information for the data set

Sub-commands:

plot1d

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

usage: gwgen sens plot plot1d [-h] [-f { 'scratch' | 'file' | 'db' | None }]
                              [-to-csv] [-to-db] [-rm] [-sf] [-o str]
                              [-onc str] [-op str] [-np] [-p str]

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

Run arguments

-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

plot2d

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

usage: gwgen sens plot plot2d [-h] [-logx] [-logy]
                              [-f { 'scratch' | 'file' | 'db' | None }]
                              [-to-csv] [-to-db] [-rm] [-sf] [-o str]
                              [-onc str] [-op str] [-np] [-p str]

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

Run arguments

-logx=False	If True, the x-axis will be logarithmic
-logy=False	If True, the y-axis will be logarithmic
-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

remove

Remove the project and files of the sensitivity analysis

usage: gwgen sens remove [-h] [-y] [-ap]

Optional Arguments

-y=False, --yes=False
	If True/set, do not ask for confirmation
-ap=False, --all-projects=False
	If True/set, all projects are removed

archive

Archive one or more experiments or a project instance This method may be used to archive experiments in order to minimize the amount of necessary configuration files

usage: gwgen archive [-h] [-d str] [-f str]
                     [-fmt { 'gztar' | 'bztar' | 'tar' | 'zip' }] [-p str]
                     [-ids exp1,[exp2[,...]]]] [-P] [-na] [-np]
                     [-e str [str ...]] [-k] [-rm] [-n] [-L]

Optional Arguments

-d, --odir	The path where to store the archive
-f, --aname	The name of the archive (minus any format-specific extension). If None, defaults to the projectname
-fmt	The format of the archive. If None, it is tested whether an archived with the name specified by `aname` already exists and if yes, the format is inferred, otherwise ``’tar’`` is used Possible choices: bztar, gztar, tar, zip
-p, --projectname
	If provided, the entire project is archived
-ids, --experiments
	If provided, the given experiments are archived. Note that an error is raised if they belong to multiple project instances
-P=False, --current-project=False
	If True, `projectname` is set to the current project
-na=False, --no-append=False
	It True and the archive already exists, it is deleted
-np=False, --no-project-paths=False
	If True, paths outside the experiment directories are neglected
-e, --exclude	Filename patterns to ignore (see :func:`glob.fnmatch.fnmatch`)
-k=False, --keep=False
	If True, the experiment directories are not removed and no modification is made in the configuration
-rm=False, --rm-project=False
	If True, remove all the project files
-n=False, --dry-run=False
	If True, set, do not actually make anything
-L=False, --dereference=False
	If set, dereference symbolic links. Note: This is automatically set for ``fmt==’zip’``

remove

Delete an existing experiment and/or projectname

usage: gwgen remove [-h] [-p [str]] [-a] [-y] [-ap]

Optional Arguments

-p, --projectname
	The name for which the data shall be removed. If set without, argument, the project will be determined by the experiment. If specified, all experiments for the given project will be removed.
-a=False, --all=False
	If set, delete not only the experiments and config files, but also all the project files
-y=False, --yes=False
	If True/set, do not ask for confirmation
-ap=False, --all-projects=False
	If True/set, all projects are removed