Skip to content

Commit fcfae49

Browse files
author
Documenter.jl
committed
build based on c297e3d
1 parent 7b18270 commit fcfae49

File tree

27 files changed

+49
-49
lines changed

27 files changed

+49
-49
lines changed

dev/API/climate/index.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

dev/API/network/index.html

Lines changed: 2 additions & 2 deletions
Large diffs are not rendered by default.

dev/API/nodes/Dam/index.html

Lines changed: 3 additions & 3 deletions
Large diffs are not rendered by default.

dev/API/nodes/EnsembleNode/index.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -4,10 +4,10 @@
44
climate::Climate,
55
obs::Vector{T};
66
period=monthday
7-
) where {T&lt;:Real}</code></pre><p>Apply bias correction using the median error for a given period (monthday)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ConnectedSystems/Streamfall.jl/blob/91a359cf5a1464a842c508ddad2959f6e3b6c593/src/Nodes/Ensembles/WeightedEnsembleNode.jl#L207-L216">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Streamfall.apply_temporal_correction-Tuple{WeightedEnsembleNode, Climate, Vector{Float64}}" href="#Streamfall.apply_temporal_correction-Tuple{WeightedEnsembleNode, Climate, Vector{Float64}}"><code>Streamfall.apply_temporal_correction</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">apply_temporal_correction(
7+
) where {T&lt;:Real}</code></pre><p>Apply bias correction using the median error for a given period (monthday)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ConnectedSystems/Streamfall.jl/blob/c297e3dabc918e0fd7f8feceb692fe1c9cd0dac1/src/Nodes/Ensembles/WeightedEnsembleNode.jl#L207-L216">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Streamfall.apply_temporal_correction-Tuple{WeightedEnsembleNode, Climate, Vector{Float64}}" href="#Streamfall.apply_temporal_correction-Tuple{WeightedEnsembleNode, Climate, Vector{Float64}}"><code>Streamfall.apply_temporal_correction</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">apply_temporal_correction(
88
ensemble::WeightedEnsembleNode,
99
climate::Climate,
1010
obs::Vector{T};
1111
low_cap::Float64=1.0,
1212
high_cap::Float64=1.0
13-
) where {T&lt;:Real}</code></pre><p>Correct for model bias using median error. By default, the correction is capped to ± 100% of model prediction modified by <code>low_cap</code> and <code>high_cap</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ConnectedSystems/Streamfall.jl/blob/91a359cf5a1464a842c508ddad2959f6e3b6c593/src/Nodes/Ensembles/WeightedEnsembleNode.jl#L176-L188">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Streamfall.calibrate!-Union{Tuple{C}, Tuple{WeightedEnsembleNode, Climate, DataFrames.DataFrame, Union{AbstractDict{String, C}, C}}} where C&lt;:Function" href="#Streamfall.calibrate!-Union{Tuple{C}, Tuple{WeightedEnsembleNode, Climate, DataFrames.DataFrame, Union{AbstractDict{String, C}, C}}} where C&lt;:Function"><code>Streamfall.calibrate!</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">calibrate!(ensemble::WeightedEnsembleNode, climate::Climate, calib_data::Union{AbstractArray,DataFrame}, metric::Union{F,AbstractDict{String,F}}; kwargs...) where {F}</code></pre><p>Calibrate individual the ensemble weights assuming the component models are pre-calibrated.</p><p><strong>Arguments</strong></p><ul><li><code>ensemble</code>: WeightedEnsembleNode containing multiple model instances</li><li><code>climate</code>: Climate data for simulation</li><li><code>calib_data</code>: Calibration data, either as an array or DataFrame with node names as columns</li><li><code>metric</code>: Optimization metric function or Dict mapping node names to metrics</li><li><code>kwargs</code>: Additional arguments passed to BlackBoxOptim</li></ul><p><strong>Returns</strong></p><ul><li>Tuple of (optimization<em>result, optimization</em>setup) from weights calibration</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ConnectedSystems/Streamfall.jl/blob/91a359cf5a1464a842c508ddad2959f6e3b6c593/src/Nodes/Ensembles/WeightedEnsembleNode.jl#L143-L157">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Streamfall.calibrate_instances!-Union{Tuple{F}, Tuple{WeightedEnsembleNode, Climate, DataFrames.DataFrame, Union{AbstractDict{String, F}, F}}} where F" href="#Streamfall.calibrate_instances!-Union{Tuple{F}, Tuple{WeightedEnsembleNode, Climate, DataFrames.DataFrame, Union{AbstractDict{String, F}, F}}} where F"><code>Streamfall.calibrate_instances!</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">calibrate_instances!(ensemble::WeightedEnsembleNode, climate::Climate, calib_data::Union{AbstractArray,DataFrame}, metric::Union{F,AbstractDict{String,F}}; kwargs...) where {F}</code></pre><p>Calibrate individual model instances and then the ensemble weights.</p><p><strong>Arguments</strong></p><ul><li><code>ensemble</code>: WeightedEnsembleNode containing multiple model instances</li><li><code>climate</code>: Climate data for simulation</li><li><code>calib_data</code>: Calibration data, either as an array or DataFrame with node names as columns</li><li><code>metric</code>: Optimization metric function or Dict mapping node names to metrics</li><li><code>kwargs</code>: Additional arguments passed to BlackBoxOptim</li></ul><p><strong>Returns</strong></p><ul><li>Tuple of (optimization<em>result, optimization</em>setup) from weights calibration</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ConnectedSystems/Streamfall.jl/blob/91a359cf5a1464a842c508ddad2959f6e3b6c593/src/Nodes/Ensembles/WeightedEnsembleNode.jl#L111-L125">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Sunday 27 April 2025 03:59">Sunday 27 April 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
13+
) where {T&lt;:Real}</code></pre><p>Correct for model bias using median error. By default, the correction is capped to ± 100% of model prediction modified by <code>low_cap</code> and <code>high_cap</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ConnectedSystems/Streamfall.jl/blob/c297e3dabc918e0fd7f8feceb692fe1c9cd0dac1/src/Nodes/Ensembles/WeightedEnsembleNode.jl#L176-L188">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Streamfall.calibrate!-Union{Tuple{C}, Tuple{WeightedEnsembleNode, Climate, DataFrames.DataFrame, Union{AbstractDict{String, C}, C}}} where C&lt;:Function" href="#Streamfall.calibrate!-Union{Tuple{C}, Tuple{WeightedEnsembleNode, Climate, DataFrames.DataFrame, Union{AbstractDict{String, C}, C}}} where C&lt;:Function"><code>Streamfall.calibrate!</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">calibrate!(ensemble::WeightedEnsembleNode, climate::Climate, calib_data::Union{AbstractArray,DataFrame}, metric::Union{F,AbstractDict{String,F}}; kwargs...) where {F}</code></pre><p>Calibrate individual the ensemble weights assuming the component models are pre-calibrated.</p><p><strong>Arguments</strong></p><ul><li><code>ensemble</code>: WeightedEnsembleNode containing multiple model instances</li><li><code>climate</code>: Climate data for simulation</li><li><code>calib_data</code>: Calibration data, either as an array or DataFrame with node names as columns</li><li><code>metric</code>: Optimization metric function or Dict mapping node names to metrics</li><li><code>kwargs</code>: Additional arguments passed to BlackBoxOptim</li></ul><p><strong>Returns</strong></p><ul><li>Tuple of (optimization<em>result, optimization</em>setup) from weights calibration</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ConnectedSystems/Streamfall.jl/blob/c297e3dabc918e0fd7f8feceb692fe1c9cd0dac1/src/Nodes/Ensembles/WeightedEnsembleNode.jl#L143-L157">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Streamfall.calibrate_instances!-Union{Tuple{F}, Tuple{WeightedEnsembleNode, Climate, DataFrames.DataFrame, Union{AbstractDict{String, F}, F}}} where F" href="#Streamfall.calibrate_instances!-Union{Tuple{F}, Tuple{WeightedEnsembleNode, Climate, DataFrames.DataFrame, Union{AbstractDict{String, F}, F}}} where F"><code>Streamfall.calibrate_instances!</code></a><span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">calibrate_instances!(ensemble::WeightedEnsembleNode, climate::Climate, calib_data::Union{AbstractArray,DataFrame}, metric::Union{F,AbstractDict{String,F}}; kwargs...) where {F}</code></pre><p>Calibrate individual model instances and then the ensemble weights.</p><p><strong>Arguments</strong></p><ul><li><code>ensemble</code>: WeightedEnsembleNode containing multiple model instances</li><li><code>climate</code>: Climate data for simulation</li><li><code>calib_data</code>: Calibration data, either as an array or DataFrame with node names as columns</li><li><code>metric</code>: Optimization metric function or Dict mapping node names to metrics</li><li><code>kwargs</code>: Additional arguments passed to BlackBoxOptim</li></ul><p><strong>Returns</strong></p><ul><li>Tuple of (optimization<em>result, optimization</em>setup) from weights calibration</li></ul></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ConnectedSystems/Streamfall.jl/blob/c297e3dabc918e0fd7f8feceb692fe1c9cd0dac1/src/Nodes/Ensembles/WeightedEnsembleNode.jl#L111-L125">source</a></section></article></article><nav class="docs-footer"><p class="footer-message">Powered by <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> and the <a href="https://julialang.org/">Julia Programming Language</a>.</p></nav></div><div class="modal" id="documenter-settings"><div class="modal-background"></div><div class="modal-card"><header class="modal-card-head"><p class="modal-card-title">Settings</p><button class="delete"></button></header><section class="modal-card-body"><p><label class="label">Theme</label><div class="select"><select id="documenter-themepicker"><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 0.27.25 on <span class="colophon-date" title="Sunday 27 April 2025 04:15">Sunday 27 April 2025</span>. Using Julia version 1.11.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

0 commit comments

Comments
 (0)