Skip to content

Commit

Permalink
build based on 0a5559d
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Feb 2, 2025
1 parent 2438450 commit f959f1f
Show file tree
Hide file tree
Showing 30 changed files with 57 additions and 56 deletions.
2 changes: 1 addition & 1 deletion dev/API/climate/index.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/API/network/index.html
View file

Large diffs are not rendered by default.

6 changes: 3 additions & 3 deletions dev/API/nodes/Dam/index.html
View file

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions dev/API/nodes/EnsembleNode/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
climate::Climate,
obs::Vector{T};
period=monthday
) 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/1a18aaca718b83df8a09fb28714264c8edae5124/src/Nodes/Ensembles/WeightedEnsembleNode.jl#L194-L203">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Streamfall.apply_temporal_correction-Union{Tuple{T}, Tuple{WeightedEnsembleNode, Climate, Vector{T}}} where T&lt;:Real" href="#Streamfall.apply_temporal_correction-Union{Tuple{T}, Tuple{WeightedEnsembleNode, Climate, Vector{T}}} where T&lt;:Real"><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(
) 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/0a5559d2dc7acbbc868c7984ad8a1c1854b09ddb/src/Nodes/Ensembles/WeightedEnsembleNode.jl#L194-L203">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="Streamfall.apply_temporal_correction-Union{Tuple{T}, Tuple{WeightedEnsembleNode, Climate, Vector{T}}} where T&lt;:Real" href="#Streamfall.apply_temporal_correction-Union{Tuple{T}, Tuple{WeightedEnsembleNode, Climate, Vector{T}}} where T&lt;:Real"><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(
ensemble::WeightedEnsembleNode,
climate::Climate,
obs::Vector{T}
) where {T&lt;:Real}</code></pre><p>Correct for model bias using median error.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ConnectedSystems/Streamfall.jl/blob/1a18aaca718b83df8a09fb28714264c8edae5124/src/Nodes/Ensembles/WeightedEnsembleNode.jl#L174-L182">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/1a18aaca718b83df8a09fb28714264c8edae5124/src/Nodes/Ensembles/WeightedEnsembleNode.jl#L141-L155">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/1a18aaca718b83df8a09fb28714264c8edae5124/src/Nodes/Ensembles/WeightedEnsembleNode.jl#L109-L123">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 26 January 2025 06:33">Sunday 26 January 2025</span>. Using Julia version 1.11.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
) where {T&lt;:Real}</code></pre><p>Correct for model bias using median error.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/ConnectedSystems/Streamfall.jl/blob/0a5559d2dc7acbbc868c7984ad8a1c1854b09ddb/src/Nodes/Ensembles/WeightedEnsembleNode.jl#L174-L182">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/0a5559d2dc7acbbc868c7984ad8a1c1854b09ddb/src/Nodes/Ensembles/WeightedEnsembleNode.jl#L141-L155">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/0a5559d2dc7acbbc868c7984ad8a1c1854b09ddb/src/Nodes/Ensembles/WeightedEnsembleNode.jl#L109-L123">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 2 February 2025 12:24">Sunday 2 February 2025</span>. Using Julia version 1.11.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit f959f1f

Please sign in to comment.