diff --git a/base/remote/man/qsub_parallel.Rd b/base/remote/man/qsub_parallel.Rd index cbd2c6614d4..a7d2f8bd751 100644 --- a/base/remote/man/qsub_parallel.Rd +++ b/base/remote/man/qsub_parallel.Rd @@ -4,7 +4,7 @@ \alias{qsub_parallel} \title{qsub_parallel} \usage{ -qsub_parallel(settings, files = NULL, prefix = "sipnet.out") +qsub_parallel(settings, files = NULL, prefix = "sipnet.out", sleep = 10) } \arguments{ \item{settings}{pecan settings object} @@ -12,6 +12,8 @@ qsub_parallel(settings, files = NULL, prefix = "sipnet.out") \item{files}{allow submit jobs based on job.sh file paths.} \item{prefix}{used for detecting if jobs are completed or not.} + +\item{sleep}{time (in second) that we wait each time for the jobs to be completed.} } \description{ qsub_parallel diff --git a/modules/assim.sequential/NAMESPACE b/modules/assim.sequential/NAMESPACE index 527ca7afbe5..aa4d926ecb5 100644 --- a/modules/assim.sequential/NAMESPACE +++ b/modules/assim.sequential/NAMESPACE @@ -9,7 +9,6 @@ export(Create_Site_PFT_CSV) export(EnKF) export(EnKF.MultiSite) export(GEF) -export(GEF.Block.Nimble) export(GEF.MultiSite) export(GEF.MultiSite.Nimble) export(GrabFillMatrix) diff --git a/modules/assim.sequential/man/GEF.Block.Nimble.Rd b/modules/assim.sequential/man/GEF.Block.Nimble.Rd deleted file mode 100644 index 2a343a1f361..00000000000 --- a/modules/assim.sequential/man/GEF.Block.Nimble.Rd +++ /dev/null @@ -1,16 +0,0 @@ -% Generated by roxygen2: do not edit by hand -% Please edit documentation in R/Nimble_codes.R -\docType{data} -\name{GEF.Block.Nimble} -\alias{GEF.Block.Nimble} -\title{block-based TWEnF} -\format{ -TBD -} -\usage{ -GEF.Block.Nimble -} -\description{ -block-based TWEnF -} -\keyword{datasets} diff --git a/modules/assim.sequential/man/analysis_sda_block.Rd b/modules/assim.sequential/man/analysis_sda_block.Rd index a95674e3b99..4be6f3ba235 100644 --- a/modules/assim.sequential/man/analysis_sda_block.Rd +++ b/modules/assim.sequential/man/analysis_sda_block.Rd @@ -19,21 +19,21 @@ analysis_sda_block( \arguments{ \item{settings}{pecan standard multi-site settings list.} -\item{block.list.all}{List contains nt empty sub-elements.} +\item{block.list.all}{Lists of forecast and analysis outputs for each time point of each block. If t=1, we initialize those outputs of each block with NULL from the `sda.enkf.multisite` function.} -\item{X}{A matrix contains ensemble forecasts.} +\item{X}{A matrix contains ensemble forecasts with the dimensions of `[ensemble number, site number * number of state variables]`. The columns are matched with the site.ids and state variable names of the inside the `FORECAST` object in the `sda.enkf.multisite` script.} -\item{obs.mean}{List of dataframe of observation means, named with observation datetime.} +\item{obs.mean}{Lists of date times named by time points, which contains lists of sites named by site ids, which contains observation means for each state variables of each site for each time point.} -\item{obs.cov}{List of covariance matrices of state variables , named with observation datetime.} +\item{obs.cov}{Lists of date times named by time points, which contains lists of sites named by site ids, which contains observation covariances for all state variables of each site for each time point.} -\item{t}{time point.} +\item{t}{time point in format of YYYY-MM-DD.} -\item{nt}{total length of time steps.} +\item{nt}{total length of time steps, corresponding to the `nt` variable in the `sda.enkf.multisite` function.} -\item{MCMC.args}{arguments for the MCMC sampling.} +\item{MCMC.args}{arguments for the MCMC sampling, details can be found in the roxygen strucutre for control list in the `sda.enkf.multisite` function.} -\item{block.list.all.pre}{pre-existed block.list.all object for passing the aqq and bqq to the current SDA run, the default is NULL.} +\item{block.list.all.pre}{pre-existed block.list.all object for passing the aqq and bqq to the current SDA run, the default is NULL. Details can be found in the roxygen structure for `pre_enkf_params` of the `sda.enkf.multisite` function} } \value{ It returns the `build.block.xy` object and the analysis results. diff --git a/modules/assim.sequential/man/sda.enkf.multisite.Rd b/modules/assim.sequential/man/sda.enkf.multisite.Rd index 62a06a1821d..9c3560b3e89 100644 --- a/modules/assim.sequential/man/sda.enkf.multisite.Rd +++ b/modules/assim.sequential/man/sda.enkf.multisite.Rd @@ -12,30 +12,40 @@ sda.enkf.multisite( restart = NULL, pre_enkf_params = NULL, ensemble.samples = NULL, - control = list(trace = TRUE, FF = FALSE, interactivePlot = FALSE, TimeseriesPlot = - FALSE, BiasPlot = FALSE, plot.title = NULL, facet.plots = FALSE, debug = FALSE, pause - = FALSE, Profiling = FALSE, OutlierDetection = FALSE, parallel_qsub = TRUE, - send_email = NULL, keepNC = TRUE, forceRun = TRUE, run_parallel = TRUE), + control = list(trace = TRUE, TimeseriesPlot = FALSE, debug = FALSE, pause = FALSE, + Profiling = FALSE, OutlierDetection = FALSE, parallel_qsub = TRUE, send_email = NULL, + keepNC = TRUE, forceRun = TRUE, run_parallel = TRUE, MCMC.args = NULL), ... ) } \arguments{ \item{settings}{PEcAn settings object} -\item{obs.mean}{List of dataframe of observation means, named with observation datetime.} +\item{obs.mean}{Lists of date times named by time points, which contains lists of sites named by site ids, which contains observation means for each state variables of each site for each time point.} -\item{obs.cov}{List of covariance matrices of state variables , named with observation datetime.} +\item{obs.cov}{Lists of date times named by time points, which contains lists of sites named by site ids, which contains observation covariances for all state variables of each site for each time point.} \item{Q}{Process covariance matrix given if there is no data to estimate it.} \item{restart}{Used for iterative updating previous forecasts. Default NULL. List object includes file path to previous runs and start date for SDA.} -\item{pre_enkf_params}{Used for carrying out SDA with pre-existed enkf.params, in which the Pf, aqq, and bqq can be used for the analysis step.} +\item{pre_enkf_params}{Used for passing pre-existing time-series of process error into the current SDA runs to ignore the impact by the differences between process errors.} \item{ensemble.samples}{Pass ensemble.samples from outside to avoid GitHub check issues.} -\item{control}{List of flags controlling the behaviour of the SDA. trace for reporting back the SDA outcomes, interactivePlot for plotting the outcomes after each step, -TimeseriesPlot for post analysis examination, BiasPlot for plotting the correlation between state variables, plot.title is the title of post analysis plots and debug mode allows for pausing the code and examining the variables inside the function.} +\item{control}{List of flags controlling the behavior of the SDA. +`trace` for reporting back the SDA outcomes; +`TimeseriesPlot` for post analysis examination; +`debug` decide if we want to pause the code and examining the variables inside the function; +`pause` decide if we want to pause the SDA workflow at current time point t; +`Profiling` decide if we want to export the temporal SDA outputs in CSV file; +`OutlierDetection` decide if we want to execute the outlier detection each time after the model forecasting; +`parallel_qsub` decide if we want to execute the `qsub` job submission under parallel mode; +`send_email` contains lists for sending email to report the SDA progress; +`keepNC` decide if we want to keep the NetCDF files inside the out directory; +`forceRun` decide if we want to proceed the Bayesian MCMC sampling without observations; +`run_parallel` decide if we want to run the SDA under parallel mode for the `future_map` function; +`MCMC.args` include lists for controling the MCMC sampling process (iteration, nchains, burnin, and nthin.).} } \value{ NONE