build based on d372675

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-29T08:07:45","documenter_version":"1.7.0"}}
+{"documenter":{"julia_version":"1.11.1","generation_timestamp":"2024-10-29T08:51:25","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="Tuesday 29 October 2024 08:07">Tuesday 29 October 2024</span>. Using Julia version 1.11.1.</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="Tuesday 29 October 2024 08:51">Tuesday 29 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/manual/basic/index.html

@@ -18,4 +18,4 @@
            [SimpleTimes(7,1), SimpleTimes(7,1)]
        );</code><code class="nohighlight hljs ansi" style="display:block;"></code></pre><p>The time periods can be iterated both for the whole time structure and individually by each representative period using the <a href="../../reference/api/#TimeStruct.repr_periods"><code>repr_periods</code></a> function. This is illustrated here when setting up a JuMP model with a separate constraint for each representative period:</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; m = Model();</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; @variable(m, prod[periods] &gt;= 0);</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; for rp in repr_periods(periods)
            @constraint(m, sum(prod[t] for t in rp) &lt;= 10)
-       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></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="Tuesday 29 October 2024 08:07">Tuesday 29 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+       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></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="Tuesday 29 October 2024 08:51">Tuesday 29 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/manual/discount/index.html

@@ -9,4 +9,4 @@
  0.485802363453121
  0.2982405095252959
  0.18309380154032812
- 0.11240371140676893</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="../../contribute/">Contribute »</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="Tuesday 29 October 2024 08:07">Tuesday 29 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ 0.11240371140676893</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="../../contribute/">Contribute »</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="Tuesday 29 October 2024 08:51">Tuesday 29 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/manual/iteration/index.html

@@ -44,4 +44,4 @@
  [t2, t3]
  [t3, t4, t5]
  [t4, t5]
- [t5]</code></pre><h2 id="man-iter-index"><a class="docs-heading-anchor" href="#man-iter-index">Indexing of operational time structures</a><a id="man-iter-index-1"></a><a class="docs-heading-anchor-permalink" href="#man-iter-index" title="Permalink"></a></h2><p>It is possible to use indices for operational time structures, either directly using <a href="../../reference/api/#TimeStruct.SimpleTimes"><code>SimpleTimes</code></a> or <a href="../../reference/api/#TimeStruct.CalendarTimes"><code>CalendarTimes</code></a> or by accessing an operational scenario.</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; periods = TwoLevel(3, 100, SimpleTimes(10,1));</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; scenario = first(opscenarios(periods))</code><code class="nohighlight hljs ansi" style="display:block;">sp1-sc1</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; scenario[3]</code><code class="nohighlight hljs ansi" style="display:block;">sp1-t3</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../profiles/">« Time profiles</a><a class="docs-footer-nextpage" href="../discount/">Discounting »</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="Tuesday 29 October 2024 08:07">Tuesday 29 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ [t5]</code></pre><h2 id="man-iter-index"><a class="docs-heading-anchor" href="#man-iter-index">Indexing of operational time structures</a><a id="man-iter-index-1"></a><a class="docs-heading-anchor-permalink" href="#man-iter-index" title="Permalink"></a></h2><p>It is possible to use indices for operational time structures, either directly using <a href="../../reference/api/#TimeStruct.SimpleTimes"><code>SimpleTimes</code></a> or <a href="../../reference/api/#TimeStruct.CalendarTimes"><code>CalendarTimes</code></a> or by accessing an operational scenario.</p><pre><code class="language-julia-repl hljs" style="display:block;">julia&gt; periods = TwoLevel(3, 100, SimpleTimes(10,1));</code><code class="nohighlight hljs ansi" style="display:block;"></code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; scenario = first(opscenarios(periods))</code><code class="nohighlight hljs ansi" style="display:block;">sp1-sc1</code><br/><code class="language-julia-repl hljs" style="display:block;">julia&gt; scenario[3]</code><code class="nohighlight hljs ansi" style="display:block;">sp1-t3</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../profiles/">« Time profiles</a><a class="docs-footer-nextpage" href="../discount/">Discounting »</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="Tuesday 29 October 2024 08:51">Tuesday 29 October 2024</span>. Using Julia version 1.11.1.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>