Skip to content

Commit

Permalink
build based on bbbbf5d
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Oct 10, 2024
1 parent f1a8df6 commit d72b885
Show file tree
Hide file tree
Showing 14 changed files with 762 additions and 0 deletions.
10 changes: 10 additions & 0 deletions previews/PR37/api/internal/index.html

Large diffs are not rendered by default.

4 changes: 4 additions & 0 deletions previews/PR37/api/public/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Public API Reference · HydroPowerSimulations.jl</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.png" alt="HydroPowerSimulations.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">HydroPowerSimulations.jl</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="../../">Welcome Page</a></li><li><a class="tocitem" href="../../quick_start_guide/">Quick Start Guide</a></li><li class="is-active"><a class="tocitem" href>Public API Reference</a></li><li><a class="tocitem" href="../internal/">Internal API Reference</a></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 class="is-active"><a href>Public API Reference</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Public API Reference</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/main/docs/src/api/public.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="Public-API-Reference"><a class="docs-heading-anchor" href="#Public-API-Reference">Public API Reference</a><a id="Public-API-Reference-1"></a><a class="docs-heading-anchor-permalink" href="#Public-API-Reference" title="Permalink"></a></h1><article class="docstring"><header><a class="docstring-binding" id="HydroPowerSimulations.HydroCommitmentReservoirBudget" href="#HydroPowerSimulations.HydroCommitmentReservoirBudget"><code>HydroPowerSimulations.HydroCommitmentReservoirBudget</code></a><span class="docstring-category">Type</span></header><section><div><p>Formulation type to add commitment and injection variables constrained by total energy production budget defined with a time series for <code>HydroGen</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/bbbbf5deb9657dfe0e3712881565acc2367beed4/src/core/formulations.jl#L32-L34">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="HydroPowerSimulations.HydroCommitmentReservoirStorage" href="#HydroPowerSimulations.HydroCommitmentReservoirStorage"><code>HydroPowerSimulations.HydroCommitmentReservoirStorage</code></a><span class="docstring-category">Type</span></header><section><div><p>Formulation type to constrain hydropower production with unit commitment variables and a representation of the energy storage capacity and water inflow time series of a reservoir for <code>HydroGen</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/bbbbf5deb9657dfe0e3712881565acc2367beed4/src/core/formulations.jl#L37-L39">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="HydroPowerSimulations.HydroCommitmentRunOfRiver" href="#HydroPowerSimulations.HydroCommitmentRunOfRiver"><code>HydroPowerSimulations.HydroCommitmentRunOfRiver</code></a><span class="docstring-category">Type</span></header><section><div><p>Formulation type to add commitment and injection variables constrained by a maximum injection time series for <code>HydroGen</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/bbbbf5deb9657dfe0e3712881565acc2367beed4/src/core/formulations.jl#L42-L44">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="HydroPowerSimulations.HydroDispatchPumpedStorage" href="#HydroPowerSimulations.HydroDispatchPumpedStorage"><code>HydroPowerSimulations.HydroDispatchPumpedStorage</code></a><span class="docstring-category">Type</span></header><section><div><p>Formulation type to constrain energy production from pumped storage with a representation of the energy storage capacity of upper and lower reservoirs and water inflow time series of upper reservoir and outflow time series of lower reservoir for <code>HydroPumpedStorage</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/bbbbf5deb9657dfe0e3712881565acc2367beed4/src/core/formulations.jl#L22-L24">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="HydroPowerSimulations.HydroDispatchReservoirBudget" href="#HydroPowerSimulations.HydroDispatchReservoirBudget"><code>HydroPowerSimulations.HydroDispatchReservoirBudget</code></a><span class="docstring-category">Type</span></header><section><div><p>Formulation type to add injection variables constrained by total energy production budget defined with a time series for <code>HydroGen</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/bbbbf5deb9657dfe0e3712881565acc2367beed4/src/core/formulations.jl#L12-L14">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="HydroPowerSimulations.HydroDispatchReservoirStorage" href="#HydroPowerSimulations.HydroDispatchReservoirStorage"><code>HydroPowerSimulations.HydroDispatchReservoirStorage</code></a><span class="docstring-category">Type</span></header><section><div><p>Formulation type to constrain hydropower production with a representation of the energy storage capacity and water inflow time series of a reservoir for <code>HydroGen</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/bbbbf5deb9657dfe0e3712881565acc2367beed4/src/core/formulations.jl#L17-L19">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="HydroPowerSimulations.HydroDispatchRunOfRiver" href="#HydroPowerSimulations.HydroDispatchRunOfRiver"><code>HydroPowerSimulations.HydroDispatchRunOfRiver</code></a><span class="docstring-category">Type</span></header><section><div><p>Formulation type to add injection variables constrained by a maximum injection time series for <code>HydroGen</code></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/bbbbf5deb9657dfe0e3712881565acc2367beed4/src/core/formulations.jl#L27-L29">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="HydroPowerSimulations.HydroEnergyOutput" href="#HydroPowerSimulations.HydroEnergyOutput"><code>HydroPowerSimulations.HydroEnergyOutput</code></a><span class="docstring-category">Type</span></header><section><div><p>Auxiliary Variable for Hydro Models that solve for total energy output</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/bbbbf5deb9657dfe0e3712881565acc2367beed4/src/core/variables.jl#L38-L40">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="HydroPowerSimulations.HydroEnergyShortageVariable" href="#HydroPowerSimulations.HydroEnergyShortageVariable"><code>HydroPowerSimulations.HydroEnergyShortageVariable</code></a><span class="docstring-category">Type</span></header><section><div><p>Struct to dispatch the creation of a slack variable for energy storage levels &lt; target storage levels</p><p>Docs abbreviation: <span>$E^{shortage}$</span></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/bbbbf5deb9657dfe0e3712881565acc2367beed4/src/core/variables.jl#L22-L26">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="HydroPowerSimulations.HydroEnergyVariableUp" href="#HydroPowerSimulations.HydroEnergyVariableUp"><code>HydroPowerSimulations.HydroEnergyVariableUp</code></a><span class="docstring-category">Type</span></header><section><div><p>Struct to dispatch the creation of a variable for energy storage level (state of charge) of upper reservoir</p><p>Docs abbreviation: <span>$E^{up}$</span></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/bbbbf5deb9657dfe0e3712881565acc2367beed4/src/core/variables.jl#L8-L12">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="HydroPowerSimulations.ReservoirLimitFeedforward" href="#HydroPowerSimulations.ReservoirLimitFeedforward"><code>HydroPowerSimulations.ReservoirLimitFeedforward</code></a><span class="docstring-category">Type</span></header><section><div><p>Adds a constraint to limit the sum of a variable over the number of periods to the source value</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/bbbbf5deb9657dfe0e3712881565acc2367beed4/src/feedforwards.jl#L133-L135">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="HydroPowerSimulations.ReservoirLimitParameter" href="#HydroPowerSimulations.ReservoirLimitParameter"><code>HydroPowerSimulations.ReservoirLimitParameter</code></a><span class="docstring-category">Type</span></header><section><div><p>Parameter to define energy limit</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/bbbbf5deb9657dfe0e3712881565acc2367beed4/src/core/parameters.jl#L25-L27">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="HydroPowerSimulations.ReservoirTargetFeedforward" href="#HydroPowerSimulations.ReservoirTargetFeedforward"><code>HydroPowerSimulations.ReservoirTargetFeedforward</code></a><span class="docstring-category">Type</span></header><section><div><p>Adds a constraint to enforce a minimum reservoir level target with a slack variable associated with a penalty term.</p><p><strong>Fields:</strong></p><pre><code class="nohighlight hljs">optmization_container_key -&gt;
source - From where the data comes
affected_values -</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/bbbbf5deb9657dfe0e3712881565acc2367beed4/src/feedforwards.jl#L1-L10">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="HydroPowerSimulations.ReservoirTargetParameter" href="#HydroPowerSimulations.ReservoirTargetParameter"><code>HydroPowerSimulations.ReservoirTargetParameter</code></a><span class="docstring-category">Type</span></header><section><div><p>Parameter to define energy target</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/bbbbf5deb9657dfe0e3712881565acc2367beed4/src/core/parameters.jl#L21-L23">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="HydroPowerSimulations.WaterSpillageVariable" href="#HydroPowerSimulations.WaterSpillageVariable"><code>HydroPowerSimulations.WaterSpillageVariable</code></a><span class="docstring-category">Type</span></header><section><div><p>Struct to dispatch the creation of energy (water) spillage variable representing energy released from a storage/reservoir not injected into the network</p><p>Docs abbreviation: <span>$S$</span></p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/HydroPowerSimulations.jl/blob/bbbbf5deb9657dfe0e3712881565acc2367beed4/src/core/variables.jl#L1-L5">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../quick_start_guide/">« Quick Start Guide</a><a class="docs-footer-nextpage" href="../internal/">Internal API Reference »</a><div class="flexbox-break"></div><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="Thursday 10 October 2024 17:29">Thursday 10 October 2024</span>. Using Julia version 1.11.0.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
Loading

0 comments on commit d72b885

Please sign in to comment.