+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Climate · Streamfall Documentation</title><script data-outdated-warner src="../../assets/warner.js"></script><link href="https://cdnjs.cloudflare.com/ajax/libs/lato-font/3.0.0/css/lato-font.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/juliamono/0.045/juliamono.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/fontawesome.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/solid.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/font-awesome/5.15.4/css/brands.min.css" rel="stylesheet" type="text/css"/><link href="https://cdnjs.cloudflare.com/ajax/libs/KaTeX/0.13.24/katex.min.css" rel="stylesheet" type="text/css"/><script>documenterBaseURL="../.."</script><script src="https://cdnjs.cloudflare.com/ajax/libs/require.js/2.3.6/require.min.js" data-main="../../assets/documenter.js"></script><script src="../../siteinfo.js"></script><script src="../../../versions.js"></script><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-dark.css" data-theme-name="documenter-dark" data-theme-primary-dark/><link class="docs-theme-link" rel="stylesheet" type="text/css" href="../../assets/themes/documenter-light.css" data-theme-name="documenter-light" data-theme-primary/><script src="../../assets/themeswap.js"></script></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img src="../../assets/logo.svg" alt="Streamfall Documentation logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">Streamfall Documentation</a></span></div><form class="docs-search" action="../../search/"><input class="docs-search-query" id="documenter-search-query" name="q" type="text" placeholder="Search docs"/></form><ul class="docs-menu"><li><a class="tocitem" href="../../">Streamfall.jl Documentation</a></li><li><a class="tocitem" href="../../primer/">Primer</a></li><li><a class="tocitem" href="../../expected_data_formats/">Input data format</a></li><li><span class="tocitem">Examples</span><ul><li><a class="tocitem" href="../../examples/examples/">Examples</a></li><li><a class="tocitem" href="../../examples/node_creation/">Node creation</a></li><li><a class="tocitem" href="../../examples/network_loading/">Network Loading</a></li><li><input class="collapse-toggle" id="menuitem-4-4" type="checkbox"/><label class="tocitem" for="menuitem-4-4"><span class="docs-label">Model evaluation</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../examples/evaluation/simple_showcase/">A simple example</a></li><li><a class="tocitem" href="../../examples/evaluation/model_comparison/">Model comparison example</a></li><li><a class="tocitem" href="../../examples/evaluation/simple_multisystem/">Simple two-system interaction</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-4-5" type="checkbox"/><label class="tocitem" for="menuitem-4-5"><span class="docs-label">Calibration</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../examples/calibration/calibration/">Example calibration</a></li><li><a class="tocitem" href="../../examples/calibration/custom_calibration/">Customized calibration</a></li></ul></li><li><input class="collapse-toggle" id="menuitem-4-6" type="checkbox"/><label class="tocitem" for="menuitem-4-6"><span class="docs-label">Ensemble modeling</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../../examples/ensembles/weighted_ensembles/">Weighted Ensemble Modeling</a></li></ul></li></ul></li><li><span class="tocitem">API</span><ul><li><a class="tocitem" href="../../metrics/">Included metrics</a></li><li><input class="collapse-toggle" id="menuitem-5-2" type="checkbox"/><label class="tocitem" for="menuitem-5-2"><span class="docs-label">Nodes</span><i class="docs-chevron"></i></label><ul class="collapsed"><li><a class="tocitem" href="../nodes/Node/">Generic node methods</a></li><li><a class="tocitem" href="../nodes/IHACRES/">IHACRES</a></li><li><a class="tocitem" href="../nodes/HyMod/">HyMod</a></li><li><a class="tocitem" href="../nodes/GR4J/">GR4J</a></li><li><a class="tocitem" href="../nodes/SIMHYD/">SIMHYD</a></li><li><a class="tocitem" href="../nodes/Dam/">Dam (Storage Level)</a></li></ul></li><li><a class="tocitem" href="../plotting/">Plotting</a></li><li><a class="tocitem" href="../network/">Network</a></li><li class="is-active"><a class="tocitem" href>Climate</a></li><li><a class="tocitem" href="../use_methods/">Methods to run a network or node</a></li></ul></li></ul><div class="docs-version-selector field has-addons"><div class="control"><span class="docs-label button is-static is-size-7">Version</span></div><div class="docs-selector control is-expanded"><div class="select is-fullwidth is-size-7"><select id="documenter-version-selector"></select></div></div></div></nav><div class="docs-main"><header class="docs-navbar"><nav class="breadcrumb"><ul class="is-hidden-mobile"><li><a class="is-disabled">API</a></li><li class="is-active"><a href>Climate</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Climate</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/ConnectedSystems/Streamfall.jl/blob/main/docs/src/API/climate.md" title="Edit on GitHub"><span class="docs-icon fab"></span><span class="docs-label is-hidden-touch">Edit on GitHub</span></a><a class="docs-settings-button fas fa-cog" id="documenter-settings-button" href="#" title="Settings"></a><a class="docs-sidebar-button fa fa-bars is-hidden-desktop" id="documenter-sidebar-button" href="#"></a></div></header><article class="content" id="documenter-page"><h1 id="Climate"><a class="docs-heading-anchor" href="#Climate">Climate</a><a id="Climate-1"></a><a class="docs-heading-anchor-permalink" href="#Climate" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="Streamfall.climate_values-Tuple{NetworkNode, Climate, Int64}" href="#Streamfall.climate_values-Tuple{NetworkNode, Climate, Int64}"><code>Streamfall.climate_values</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">climate_values(node::NetworkNode, climate::Climate, timestep::Int)</code></pre><p>Extract climate related data for a given time step.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ConnectedSystems/Streamfall.jl/blob/91a359cf5a1464a842c508ddad2959f6e3b6c593/src/Climate.jl#L104-L108">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Streamfall.climate_values-Tuple{NetworkNode, Climate}" href="#Streamfall.climate_values-Tuple{NetworkNode, Climate}"><code>Streamfall.climate_values</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">climate_values(node::NetworkNode, climate::Climate)</code></pre><p>Extract climate related data.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ConnectedSystems/Streamfall.jl/blob/91a359cf5a1464a842c508ddad2959f6e3b6c593/src/Climate.jl#L149-L153">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Streamfall.extract_climate-Tuple{DataFrames.DataFrame}" href="#Streamfall.extract_climate-Tuple{DataFrames.DataFrame}"><code>Streamfall.extract_climate</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Create a climate dataset of Precipitation (P) and Potential Evapotranspiration (PET). Data for multiple gauges may be defined in a single dataset.</p><p>P and PET columns are identified by <code>_P</code> and <code>_PET</code> suffixes by default.</p><p><strong>Arguments</strong></p><ul><li><code>data</code> : Observation data</li><li><code>P_suffix</code> : Suffix used to indicate precipitation (default: "_P")</li><li><code>PET_suffix</code> : Suffix used to indicate Potential Evapotranspiration (default: "_PET")</li><li><code>T_suffix</code> : Suffix used to indicate Temperature (default: "_PET")</li></ul><p><strong>Returns</strong></p><p>Climate</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ConnectedSystems/Streamfall.jl/blob/91a359cf5a1464a842c508ddad2959f6e3b6c593/src/Climate.jl#L56-L70">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Streamfall.extract_flow-Tuple{DataFrames.DataFrame, String}" href="#Streamfall.extract_flow-Tuple{DataFrames.DataFrame, String}"><code>Streamfall.extract_flow</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">extract_flow(
0 commit comments