Package: foreSIGHT 1.2.0

David McInerney

foreSIGHT: Systems Insights from Generation of Hydroclimatic Timeseries

A tool to create hydroclimate scenarios, stress test systems and visualize system performance in scenario-neutral climate change impact assessments. Scenario-neutral approaches 'stress-test' the performance of a modelled system by applying a wide range of plausible hydroclimate conditions (see Brown & Wilby (2012) <doi:10.1029/2012EO410001> and Prudhomme et al. (2010) <doi:10.1016/j.jhydrol.2010.06.043>). These approaches allow the identification of hydroclimatic variables that affect the vulnerability of a system to hydroclimate variation and change. This tool enables the generation of perturbed time series using a range of approaches including simple scaling of observed time series (e.g. Culley et al. (2016) <doi:10.1002/2015WR018253>) and stochastic simulation of perturbed time series via an inverse approach (see Guo et al. (2018) <doi:10.1016/j.jhydrol.2016.03.025>). It incorporates 'Richardson-type' weather generator model configurations documented in Richardson (1981) <doi:10.1029/WR017i001p00182>, Richardson and Wright (1984), as well as latent variable type model configurations documented in Bennett et al. (2018) <doi:10.1016/j.jhydrol.2016.12.043>, Rasmussen (2013) <doi:10.1002/wrcr.20164>, Bennett et al. (2019) <doi:10.5194/hess-23-4783-2019> to generate hydroclimate variables on a daily basis (e.g. precipitation, temperature, potential evapotranspiration) and allows a variety of different hydroclimate variable properties, herein called attributes, to be perturbed. Options are included for the easy integration of existing system models both internally in R and externally for seamless 'stress-testing'. A suite of visualization options for the results of a scenario-neutral analysis (e.g. plotting performance spaces and overlaying climate projection information) are also included. Version 1.0 of this package is described in Bennett et al. (2021) <doi:10.1016/j.envsoft.2021.104999>. As further developments in scenario-neutral approaches occur the tool will be updated to incorporate these advances.

Authors:Bree Bennett [aut], Sam Culley [aut], Anjana Devanand [aut], David McInerney [aut, cre], Seth Westra [aut], Danlu Guo [ctb], Holger Maier [ths]

foreSIGHT_1.2.0.tar.gz
foreSIGHT_1.2.0.zip(r-4.5)foreSIGHT_1.2.0.zip(r-4.4)foreSIGHT_1.2.0.zip(r-4.3)
foreSIGHT_1.2.0.tgz(r-4.4-x86_64)foreSIGHT_1.2.0.tgz(r-4.4-arm64)foreSIGHT_1.2.0.tgz(r-4.3-x86_64)foreSIGHT_1.2.0.tgz(r-4.3-arm64)
foreSIGHT_1.2.0.tar.gz(r-4.5-noble)foreSIGHT_1.2.0.tar.gz(r-4.4-noble)
foreSIGHT_1.2.0.tgz(r-4.4-emscripten)foreSIGHT_1.2.0.tgz(r-4.3-emscripten)
foreSIGHT.pdf |foreSIGHT.html
foreSIGHT/json (API)
NEWS

# Install 'foreSIGHT' in R:
install.packages('foreSIGHT', repos = c('https://climateanalytics.r-universe.dev', 'https://cloud.r-project.org'))

Peer review:

Bug tracker:https://github.com/climateanalytics/foresight/issues

Uses libs:
  • c++– GNU Standard C++ Library v3
Datasets:
  • barossa_obs - Multi-site rainfall observations in the Barossa Valley used in examples and vignette
  • egClimData - Climate attributes from projections.
  • egMultiSiteSim - Output from call to generateScenarios() using multi-site model (see example 5 in generateScenarios).
  • egScalPerformance - Performance metrics of the tank model using simple scaled scenarios.
  • egScalSummary - Summary of a simple scaled scenario.
  • egSimOATPerformance - Performance metrics of the tank model using OAT scenarios.
  • egSimOATSummary - Summary of a OAT scenario.
  • egSimPerformance - Performance metrics of the tank model using regGrid scenarios.
  • egSimPerformance_systemB - Performance metrics of an alternate tank model using regGrid scenarios.
  • egSimSummary - Summary of a regGrid scenario.
  • tank_obs - Observations for demo tank model examples and vignette

On CRAN:

41 exports 1 stars 0.95 score 58 dependencies 18 scripts 393 downloads

Last updated 11 months agofrom:dcf9c72434. Checks:OK: 9. Indexed: yes.

TargetResultDate
Doc / VignettesOKSep 16 2024
R-4.5-win-x86_64OKSep 16 2024
R-4.5-linux-x86_64OKSep 16 2024
R-4.4-win-x86_64OKSep 16 2024
R-4.4-mac-x86_64OKSep 16 2024
R-4.4-mac-aarch64OKSep 16 2024
R-4.3-win-x86_64OKSep 16 2024
R-4.3-mac-x86_64OKSep 16 2024
R-4.3-mac-aarch64OKSep 16 2024

Exports:calculateAttributescreateExpSpacefunc_avgfunc_avgDSDfunc_avgWSDfunc_CSLfunc_dyWetfunc_F0func_GSLfunc_maxDSDfunc_maxWSDfunc_nWetfunc_Pfunc_Rfunc_rngfunc_seasRatiofunc_totfunc_wettest6monPeakDayfunc_wettest6monSeasRatiogenerateScenariogenerateScenariosgetSimSummarymodCalibratormodSimulatorplotExpSpaceplotMultiSiteScenariosplotOptionsplotPerformanceOATplotPerformanceSpaceplotPerformanceSpaceMultiplotScenariosrunSystemModeltankWrapperviewAttributeDefviewAttributeFuncsviewDefaultOptimArgsviewModelParametersviewModelsviewTankMetricsviewVariableswriteControlFile

Dependencies:clicmaescodetoolscolorspacecowplotcpp11crayondata.tabledfoptimdirectlabelsdotCall64fansifarverfieldsforeachGAgenericsggplot2gluegtablehmsisobanditeratorsjsonlitelabelinglatticelifecyclelubridatemagrittrmapsMASSMatrixmgcvmomentsmunsellmvtnormnlmepillarpkgconfigprettyunitsprogressquadprogR6RColorBrewerrcorporaRcppRcppArmadilloRGNrlangscalesSoilHyPspamtibbletimechangeutf8vctrsviridisLitewithr

Detailed Tutorial: Climate 'Stress-Testing' using foreSIGHT

Rendered fromVignette_Tutorial.Rmdusingknitr::rmarkdown_notangleon Sep 16 2024.

Last update: 2023-10-25
Started: 2022-10-12

Quick Start Guide: Rainwater Tank Case Study

Rendered fromVignette_QuickStart_simpleScal.Rmdusingknitr::rmarkdown_notangleon Sep 16 2024.

Last update: 2023-10-25
Started: 2022-10-12

Readme and manuals

Help Manual

Help pageTopics
Multi-site rainfall observations in the Barossa Valley used in examples and vignettebarossa_obs
Calculates the attributes of the hydroclimate time seriescalculateAttributes
Example climate projection dataclimdata
Creates exposure space of hydroclimatic targets for generation of scenarios using 'generateScenarios'createExpSpace
Climate attributes from projections.egClimData
Output from call to generateScenarios() using multi-site model (see example 5 in generateScenarios).egMultiSiteSim
Performance metrics of the tank model using simple scaled scenarios.egScalPerformance
Summary of a simple scaled scenario.egScalSummary
Performance metrics of the tank model using OAT scenarios.egSimOATPerformance
Summary of a OAT scenario.egSimOATSummary
Performance metrics of the tank model using regGrid scenarios.egSimPerformance
Performance metrics of an alternate tank model using regGrid scenarios.egSimPerformance_systemB
Summary of a regGrid scenario.egSimSummary
foreSIGHT: A package for Systems Insights from Generation of Hydroclimatic TimeseriesforeSIGHT
Calculates average of time seriesfunc_avg
Calculates average dry spell duration (below threshold)func_avgDSD
Calculates average wet spell duration (below threshold)func_avgWSD
Calculates the cold season lengthfunc_CSL
Calculates average rainfall on wet days (above threshold)func_dyWet
Calculates the number of frost daysfunc_F0
Calculates the growing season lengthfunc_GSL
Calculates maximum dry spell duration (below threshold)func_maxDSD
Calculates maximum wet spell duration (above threshold)func_maxWSD
Calculates number of wet days (above threshold)func_nWet
Calculates a quantile valuefunc_P
Calculates the number of days above a threshold (often used for temperature)func_R
Calculates the inter-quantile rangefunc_rng
Calculates seasonality ratiofunc_seasRatio
Calculates total of time seriesfunc_tot
Calculates the day of year corresponding to the wettest 6 monthsfunc_wettest6monPeakDay
Calculates the ratio of wet season to dry season rainfall, based on wettest6monPeakDayfunc_wettest6monSeasRatio
Produces time series of hydroclimatic variables for an exposure target.generateScenario
Produces time series of hydroclimatic variables for an exposure space.generateScenarios
Produces a summary object containing the metadata of a full simulationgetSimSummary
modCalibratormodCalibrator
modSimulatormodSimulator
Plots the location of points in a two-dimensional exposure spaceplotExpSpace
Creates summary plots of the biases in the multi-site scenariosplotMultiSiteScenarios
Plots the differences in performance metrics from two system optionsplotOptions
Plots performance for one-at-a-time (OAT) perturbations in attributesplotPerformanceOAT
Plots a performance space using the system performance and scenarios as inputplotPerformanceSpace
Plots contours of the number of performance thresholds exceeded in the perturbation spaceplotPerformanceSpaceMulti
Creates summary plots of the biases in the scenariosplotScenarios
Runs a system model and outputs the system performancerunSystemModel
Observations for demo tank model examples and vignettetank_obs
A function to calculate difference performance from simulated tank behaviourtankPerformance
Wrapper function for a rain water tank system modeltankWrapper
Prints the definition of an attributeviewAttributeDef
Prints the list of built-in attribute functionsviewAttributeFuncs
Prints the default optimisation argumentsviewDefaultOptimArgs
Prints the names and bounds of the parameters of the stochastic modelsviewModelParameters
Prints the available stochastic model optionsviewModels
Prints the names of the performance metrics of the rain water tank system modelviewTankMetrics
Prints the names of and units of valid variablesviewVariables
Writes a sample 'controlFile.json' filewriteControlFile