build based on 0d83938

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-18T07:15:47","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.10.5","generation_timestamp":"2024-09-18T12:20:32","documenter_version":"1.7.0"}}

dev/index.html

@@ -15,4 +15,4 @@
   doi          = {10.5281/zenodo.10511399},
   publisher    = {Zenodo},
   url          = {https://zenodo.org/records/10511399}
-}</code></pre><h2 id="Acknowledgements"><a class="docs-heading-anchor" href="#Acknowledgements">Acknowledgements</a><a id="Acknowledgements-1"></a><a class="docs-heading-anchor-permalink" href="#Acknowledgements" title="Permalink"></a></h2><p>This material is based upon work supported by the Research Council of Norway through the projects ZeroKyst (328721), MaritimeNH3 (328679) and CleanExport (308811).</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="manual/basic/">Operational time structures »</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Wednesday 18 September 2024 07:15">Wednesday 18 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+}</code></pre><h2 id="Acknowledgements"><a class="docs-heading-anchor" href="#Acknowledgements">Acknowledgements</a><a id="Acknowledgements-1"></a><a class="docs-heading-anchor-permalink" href="#Acknowledgements" title="Permalink"></a></h2><p>This material is based upon work supported by the Research Council of Norway through the projects ZeroKyst (328721), MaritimeNH3 (328679) and CleanExport (308811).</p></article><nav class="docs-footer"><a class="docs-footer-nextpage" href="manual/basic/">Operational time structures »</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Wednesday 18 September 2024 12:20">Wednesday 18 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/manual/basic/index.html

@@ -17,23 +17,23 @@
        end</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; @constraint(m, sum(prod[t] * multiple(t) for t in periods) &lt;= 1);</code><code class="nohighlight hljs ansi" style="display:block;"></code></pre><p>For each time period the <a href="../../reference/api/#TimeStruct.multiple"><code>multiple</code></a> function returns how many times the given period should be counted when aggregating to the whole <a href="../../reference/api/#TimeStruct.RepresentativePeriods"><code>RepresentativePeriods</code></a> structure. This will take into account both the duration and share of each representative period, thus we have that:</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; sum(duration(t) * multiple(t) for t in periods)</code><code class="nohighlight hljs ansi" style="display:block;">365.0000000000001</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; duration(periods)</code><code class="nohighlight hljs ansi" style="display:block;">ERROR: MethodError: no method matching duration(::RepresentativePeriods{Int64, Int64, SimpleTimes{Int64}})
 
 Closest candidates are:
-  duration(<span class="sgr91">::TimeStruct.OperationalPeriod</span>)
-<span class="sgr90">   @</span> <span class="sgr35">TimeStruct</span> <span class="sgr90">~/work/TimeStruct.jl/TimeStruct.jl/src/strategic/<span class="sgr4">core_types.jl:208</span></span>
   duration(<span class="sgr91">::TimeStruct.TreePeriod</span>)
 <span class="sgr90">   @</span> <span class="sgr35">TimeStruct</span> <span class="sgr90">~/work/TimeStruct.jl/TimeStruct.jl/src/strat_scenarios/<span class="sgr4">core_types.jl:87</span></span>
+  duration(<span class="sgr91">::TimeStruct.OperationalPeriod</span>)
+<span class="sgr90">   @</span> <span class="sgr35">TimeStruct</span> <span class="sgr90">~/work/TimeStruct.jl/TimeStruct.jl/src/strategic/<span class="sgr4">core_types.jl:209</span></span>
   duration(<span class="sgr91">::TimeStruct.ScenarioPeriod</span>)
-<span class="sgr90">   @</span> <span class="sgr35">TimeStruct</span> <span class="sgr90">~/work/TimeStruct.jl/TimeStruct.jl/src/op_scenarios/<span class="sgr4">core_types.jl:128</span></span>
+<span class="sgr90">   @</span> <span class="sgr35">TimeStruct</span> <span class="sgr90">~/work/TimeStruct.jl/TimeStruct.jl/src/op_scenarios/<span class="sgr4">core_types.jl:125</span></span>
   ...</code></pre><h2 id="Operational-scenarios"><a class="docs-heading-anchor" href="#Operational-scenarios">Operational scenarios</a><a id="Operational-scenarios-1"></a><a class="docs-heading-anchor-permalink" href="#Operational-scenarios" title="Permalink"></a></h2><p>Operations often face uncertain operating conditions. In energy systems modeling, a typical example is the availability of wind and solar power. One method for accounting for this uncertainty is to have multiple operational scenarios that are used to evaluate the cost and feasibility of operations, where each scenario has a given probability of occurring.</p><p>The time structure <a href="../../reference/api/#TimeStruct.OperationalScenarios"><code>OperationalScenarios</code></a> represents an unordered collection of operational scenarios where each scenario has a separate time structure and an associated probability.</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; using TimeStruct, JuMP</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; scenarios = OperationalScenarios(
            3,
            [SimpleTimes(5,1), SimpleTimes(7,2), SimpleTimes(10,1)],
            [0.3, 0.2, 0.5]
        );</code><code class="nohighlight hljs ansi" style="display:block;"></code></pre><p><img src="../../figures/scenario.png" alt="Illustration of OperationalScenarios"/></p><p>Similar to representative periods, each period has a <a href="../../reference/api/#TimeStruct.multiple"><code>multiple</code></a> that is defined relative to the maximum duration for all scenarios. In addition, each time period has a <a href="../../reference/api/#TimeStruct.probability"><code>probability</code></a>equal to the probability of its scenario. Thus we have that:</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; sum(duration(t) * probability(t) * multiple(t) for t in scenarios)</code><code class="nohighlight hljs ansi" style="display:block;">13.999999999999996</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; duration(scenarios)</code><code class="nohighlight hljs ansi" style="display:block;">ERROR: MethodError: no method matching duration(::OperationalScenarios{Int64, SimpleTimes{Int64}})
 
 Closest candidates are:
-  duration(<span class="sgr91">::TimeStruct.OperationalPeriod</span>)
-<span class="sgr90">   @</span> <span class="sgr35">TimeStruct</span> <span class="sgr90">~/work/TimeStruct.jl/TimeStruct.jl/src/strategic/<span class="sgr4">core_types.jl:208</span></span>
   duration(<span class="sgr91">::TimeStruct.TreePeriod</span>)
 <span class="sgr90">   @</span> <span class="sgr35">TimeStruct</span> <span class="sgr90">~/work/TimeStruct.jl/TimeStruct.jl/src/strat_scenarios/<span class="sgr4">core_types.jl:87</span></span>
+  duration(<span class="sgr91">::TimeStruct.OperationalPeriod</span>)
+<span class="sgr90">   @</span> <span class="sgr35">TimeStruct</span> <span class="sgr90">~/work/TimeStruct.jl/TimeStruct.jl/src/strategic/<span class="sgr4">core_types.jl:209</span></span>
   duration(<span class="sgr91">::TimeStruct.ScenarioPeriod</span>)
-<span class="sgr90">   @</span> <span class="sgr35">TimeStruct</span> <span class="sgr90">~/work/TimeStruct.jl/TimeStruct.jl/src/op_scenarios/<span class="sgr4">core_types.jl:128</span></span>
-  ...</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Introduction</a><a class="docs-footer-nextpage" href="../multi/">Multi-horizon »</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Wednesday 18 September 2024 07:15">Wednesday 18 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+<span class="sgr90">   @</span> <span class="sgr35">TimeStruct</span> <span class="sgr90">~/work/TimeStruct.jl/TimeStruct.jl/src/op_scenarios/<span class="sgr4">core_types.jl:125</span></span>
+  ...</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Introduction</a><a class="docs-footer-nextpage" href="../multi/">Multi-horizon »</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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Wednesday 18 September 2024 12:20">Wednesday 18 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/manual/discount/index.html

@@ -9,4 +9,4 @@
  0.5991774152020056
  0.3678429564148064
  0.225823666164665
- 0.1386361416216524</code></pre><p>While it is often normal to assume investments at the start of each strategic period, it can be more correct to average the discount factor for operational costs that are accrued throughout the strategic period.</p><p>To help setting up the objective function in a typical optimization problem, there is a utility function <a href="../../reference/api/#TimeStruct.objective_weight"><code>objective_weight</code></a> that returns the weight to give a time period in the objective, considering both discount factor, probability and possible multiplicity.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../iteration/">« Iteration utilities</a><a class="docs-footer-nextpage" href="../../reference/api/">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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Wednesday 18 September 2024 07:15">Wednesday 18 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ 0.1386361416216524</code></pre><p>While it is often normal to assume investments at the start of each strategic period, it can be more correct to average the discount factor for operational costs that are accrued throughout the strategic period.</p><p>To help setting up the objective function in a typical optimization problem, there is a utility function <a href="../../reference/api/#TimeStruct.objective_weight"><code>objective_weight</code></a> that returns the weight to give a time period in the objective, considering both discount factor, probability and possible multiplicity.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../iteration/">« Iteration utilities</a><a class="docs-footer-nextpage" href="../../reference/api/">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="auto">Automatic (OS)</option><option value="documenter-light">documenter-light</option><option value="documenter-dark">documenter-dark</option><option value="catppuccin-latte">catppuccin-latte</option><option value="catppuccin-frappe">catppuccin-frappe</option><option value="catppuccin-macchiato">catppuccin-macchiato</option><option value="catppuccin-mocha">catppuccin-mocha</option></select></div></p><hr/><p>This document was generated with <a href="https://github.com/JuliaDocs/Documenter.jl">Documenter.jl</a> version 1.7.0 on <span class="colophon-date" title="Wednesday 18 September 2024 12:20">Wednesday 18 September 2024</span>. Using Julia version 1.10.5.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>