generateWeatherSeries: Simulate gridded weather function

View source: R/generateWeatherSeries.R

generateWeatherSeriesR Documentation

Simulate gridded weather function

Description

Description goes here....

Usage

generateWeatherSeries(
  weather.data = NULL,
  weather.grid = NULL,
  weather.date = NULL,
  variable.names = NULL,
  variable.labels = NULL,
  variable.units = NULL,
  sim.year.num = NULL,
  sim.year.start = 2020,
  month.start = 1,
  realization.num = 5,
  warm.variable = "precip",
  warm.signif.level = 0.9,
  warm.sample.num = 5000,
  warm.subset.criteria = NULL,
  knn.sample.num = 120,
  mc.wet.quantile = 0.3,
  mc.extreme.quantile = 0.8,
  dry.spell.change = rep(1, 12),
  wet.spell.change = rep(1, 12),
  evaluate.model = FALSE,
  evaluate.grid.num = 20,
  output.path = tempdir(),
  seed = sample.int(1e+05, 1),
  compute.parallel = TRUE,
  num.cores = NULL
)

Arguments

weather.data

list of data frames of daily weather observations per grid cell. Each data frame, columns are weather variables and rows are daily values.

weather.grid

Data frame of grid cells. Each grid cell is assigned an id starting from 1, x and y coordinate index value, and x and y coordinates.

weather.date

a vector of dates matching the weather.data

variable.names

vector of names for the variables to be included in the weather generator

variable.labels

vector of labels for the weather variables (optional). If no values provided, it is labels will be same as the names

variable.units

vector of units for each of the weather variables (optional). If no values provided, a blank vector is used.

sim.year.num

numeric value indicating the desired total number of years of simulated weather realizations

sim.year.start

numeric value indicating the starting year of the generated time-series

month.start

the first month of the water year (default value is 1).

realization.num

number of natural variability realizations to be generated.

warm.variable

the name of the variable for the wavelet auto regressive mode. Default value is precipitation variable.

warm.signif.level

the significance level for the warm model.

warm.sample.num

number of annual sequences to be generated from the the warm model

warm.subset.criteria

A list of statistical parameters used for subsetting from the initial annual simulated series

knn.sample.num

number of knn years to be sampled

mc.wet.quantile

wet state threshold (quantile value) for markov-chain modeling

mc.extreme.quantile

extremely wet state threshold (quantile value) for markov-chain modeling

dry.spell.change

placeholder

wet.spell.change

placeholder

evaluate.model

logical value indicating weather to save model evaluation plots

evaluate.grid.num

Number of grid cells to be sampled in the evaluation plots

output.path

output path for the weather generator results (string)

seed

a random seed value (numeric)

compute.parallel

logical value indicating whether to run (some) functions in parallel

num.cores

Number of cores to be allocated for parallel computing. If left NULL, maximum possible cores minus one is assigned


Deltares/weathergenr documentation built on July 25, 2024, 6:15 p.m.