build based on 012a28d

dev/.documenter-siteinfo.json

@@ -1 +1 @@
-{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-04T17:06:04","documenter_version":"1.8.0"}}
+{"documenter":{"julia_version":"1.11.2","generation_timestamp":"2024-12-04T20:26:55","documenter_version":"1.8.0"}}

dev/Getting_Started/commercial_solvers/index.html

@@ -7,4 +7,4 @@
 (GenX) pkg&gt; add CPLEX</code></pre><ul><li>Edit the <code>Run.jl</code> file to use the commercial solver. For example, to use Gurobi, you can add the following lines to the <code>Run.jl</code> file:</li></ul><pre><code class="language-julia hljs">using Gurobi
 using GenX
 
-run_genx_case!(dirname(@__FILE__), Gurobi.Optimizer)</code></pre><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>Note that if you have not already installed the required Julia packages or you do not have a valid Gurobi license on your host machine, you will receive an error message and Run.jl will not run to completion.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../examples_casestudies/">« Running GenX</a><a class="docs-footer-nextpage" href="../../Tutorials/Tutorials_intro/">Tutorials Overview »</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.8.0 on <span class="colophon-date" title="Wednesday 4 December 2024 17:06">Wednesday 4 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+run_genx_case!(dirname(@__FILE__), Gurobi.Optimizer)</code></pre><div class="admonition is-warning"><header class="admonition-header">Warning</header><div class="admonition-body"><p>Note that if you have not already installed the required Julia packages or you do not have a valid Gurobi license on your host machine, you will receive an error message and Run.jl will not run to completion.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../examples_casestudies/">« Running GenX</a><a class="docs-footer-nextpage" href="../../Tutorials/Tutorials_intro/">Tutorials Overview »</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.8.0 on <span class="colophon-date" title="Wednesday 4 December 2024 20:26">Wednesday 4 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

dev/Getting_Started/examples_casestudies/index.html

@@ -45,4 +45,4 @@
 run_genx_case!(dirname(@__FILE__), Gurobi.Optimizer)</code></pre><p>To run the case, open a terminal and run the following command:</p><pre><code class="nohighlight hljs">$ julia --project=&quot;/path/to/env&quot;
 julia&gt; include(&quot;/path/to/MyCase/Run.jl&quot;)</code></pre><p>where <code>/path/to/env</code> is the path to the environment with <code>GenX</code> installed, and <code>/path/to/MyCase</code> is the path to the folder of the <code>MyCase</code> case. Alternatively, you can run the case directly from the terminal using the following command:</p><pre><code class="nohighlight hljs">$ julia --project=&quot;/path/to/env&quot; /path/to/MyCase/Run.jl</code></pre><h2 id="What-happens-when-you-run-a-case"><a class="docs-heading-anchor" href="#What-happens-when-you-run-a-case">What happens when you run a case</a><a id="What-happens-when-you-run-a-case-1"></a><a class="docs-heading-anchor-permalink" href="#What-happens-when-you-run-a-case" title="Permalink"></a></h2><p><em>Added in 0.3.4</em></p><p>The entry point for running a GenX case is the <code>run_genx_case!(&quot;path/to/case&quot;)</code> function, where <code>path/to/case</code> is the path to the case directory that contains the <code>.csv</code> files with the inputs for GenX and the <code>settings</code> folder with the configuration files.</p><p>The following are the main steps performed in this function:</p><ol><li>Establish path to environment setup files and GenX source files.</li><li>Read in model settings <code>genx_settings.yml</code> from the example directory.</li><li>Configure solver settings.</li><li>Load the model inputs from the example directory and perform time-domain clustering if required.</li><li>Generate a GenX model instance.</li><li>Solve the model.</li><li>Write the output files to a specified directory.</li></ol><p>After the script runs to completion, results will be written to a folder called <code>results</code>, located in the current working directory.</p><h2 id="Precompile-GenX"><a class="docs-heading-anchor" href="#Precompile-GenX">Precompile GenX</a><a id="Precompile-GenX-1"></a><a class="docs-heading-anchor-permalink" href="#Precompile-GenX" title="Permalink"></a></h2><p><em>Added in 0.4.1</em></p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>By default, GenX is precompiled when the package is installed to reduce the latency of the first execution of a case. This process may take a couple of minutes, but it will reduce the time needed to run subsequent cases.</p></div></div><p>However, if you want to disable precompilation, you can set the environment variable <code>GENX_PRECOMPILE</code> to <code>&quot;false&quot;</code> before loading GenX:</p><pre><code class="nohighlight hljs">$ julia --project=&quot;/path/to/env&quot;
 julia&gt; ENV[&quot;GENX_PRECOMPILE&quot;] = &quot;false&quot;
-julia&gt; using GenX</code></pre><p>Here, <code>/path/to/env</code> is the path to the environment where GenX is installed.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>The environment variable <code>GENX_PRECOMPILE</code> must be set before loading GenX for the first time. However, to force recompilation of GenX, you can delete the <code>~/.julia/compiled/vZ.Y/GenX/*.ji</code> binaries (where vZ.Y is the version of Julia being used, e.g., v1.9), set the environment variable <code>GENX_PRECOMPILE</code> to the desired value, and then reload the package. If GenX was imported via <code>Pkg.develop</code> or <code>] dev</code>, modifying any of the package files will also force recompilation.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../third_party_genx/">« Third Party Extensions</a><a class="docs-footer-nextpage" href="../commercial_solvers/">Commertial solvers »</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.8.0 on <span class="colophon-date" title="Wednesday 4 December 2024 17:06">Wednesday 4 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+julia&gt; using GenX</code></pre><p>Here, <code>/path/to/env</code> is the path to the environment where GenX is installed.</p><div class="admonition is-info"><header class="admonition-header">Note</header><div class="admonition-body"><p>The environment variable <code>GENX_PRECOMPILE</code> must be set before loading GenX for the first time. However, to force recompilation of GenX, you can delete the <code>~/.julia/compiled/vZ.Y/GenX/*.ji</code> binaries (where vZ.Y is the version of Julia being used, e.g., v1.9), set the environment variable <code>GENX_PRECOMPILE</code> to the desired value, and then reload the package. If GenX was imported via <code>Pkg.develop</code> or <code>] dev</code>, modifying any of the package files will also force recompilation.</p></div></div></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../third_party_genx/">« Third Party Extensions</a><a class="docs-footer-nextpage" href="../commercial_solvers/">Commertial solvers »</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.8.0 on <span class="colophon-date" title="Wednesday 4 December 2024 20:26">Wednesday 4 December 2024</span>. Using Julia version 1.11.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>