Skip to content

Commit

Permalink
build based on b3a8298
Browse files Browse the repository at this point in the history
  • Loading branch information
Documenter.jl committed Aug 23, 2024
1 parent 3b1ad1c commit b8c5149
Show file tree
Hide file tree
Showing 6 changed files with 6 additions and 6 deletions.
2 changes: 1 addition & 1 deletion dev/aggreg/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/api/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion dev/datageneration/index.html
Original file line number Diff line number Diff line change
@@ -1,2 +1,2 @@
<!DOCTYPE html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Data generation · EnergySystemModeling.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><link href="../assets/favicon.ico" rel="icon" type="image/x-icon"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="EnergySystemModeling.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">EnergySystemModeling.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="../">Home</a></li><li><a class="tocitem" href="../aggreg/">Aggreg.jl</a></li><li><a class="tocitem" href="../plotting/">Plotting</a></li><li class="is-active"><a class="tocitem" href>Data generation</a><ul class="internal"><li><a class="tocitem" href="#Setup-and-data-generation-in-GlobalEnergyGIS"><span>Setup and data generation in GlobalEnergyGIS</span></a></li><li><a class="tocitem" href="#Run*data*generation.jl"><span>Run<em>data</em>generation.jl</span></a></li></ul></li><li><a class="tocitem" href="../api/">API</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>Data generation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Data generation</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/gamma-opt/EnergySystemModeling.jl/blob/master/docs/src/datageneration.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="Data-generation"><a class="docs-heading-anchor" href="#Data-generation">Data generation</a><a id="Data-generation-1"></a><a class="docs-heading-anchor-permalink" href="#Data-generation" title="Permalink"></a></h1><h2 id="Setup-and-data-generation-in-GlobalEnergyGIS"><a class="docs-heading-anchor" href="#Setup-and-data-generation-in-GlobalEnergyGIS">Setup and data generation in GlobalEnergyGIS</a><a id="Setup-and-data-generation-in-GlobalEnergyGIS-1"></a><a class="docs-heading-anchor-permalink" href="#Setup-and-data-generation-in-GlobalEnergyGIS" title="Permalink"></a></h2><p>If the user wants to generate completely new instances, they first need to set up GlobalEnergyGIS: https://github.com/niclasmattsson/GlobalEnergyGIS . Especially important is the first part &quot;Setup and data generation&quot;. This allows the user to create datasets of renewable energy independant of EnergySystemModeling. After the user set up their Copernicus account and downloaded the auxiliary datasets, rasterized them and downloaded ERA5 data, they can start generating their own instances in EnergySystemModeling.</p><h2 id="Run*data*generation.jl"><a class="docs-heading-anchor" href="#Run*data*generation.jl">Run<em>data</em>generation.jl</a><a id="Run*data*generation.jl-1"></a><a class="docs-heading-anchor-permalink" href="#Run*data*generation.jl" title="Permalink"></a></h2><p>After the setup of GlobalEnergyGIS, the user can create a new instance by running the run<em>data</em>generation.jl file. </p><p>The first thing the user has to do is to define the input values for the function</p><pre><code class="nohighlight hljs">julia&gt; create_data_sets(inputdata, sspscenario_input, sspyear_input, era_year_input, Dataset, folder, subfolder, instance, T, t, Fmin)</code></pre><p>These input values are:</p><ul><li>inputdata: Path to the output folder of GlobalEnergyGIS</li><li>sspscenario_input: One of three scenarios: ssp1, ssp2 or ssp3. All are scenarios of projected socioeconomic global changes up to 2100. They are used to derive greenhouse gas emissions scenarios with different climate policies.</li><li>sspyear_input: Target year of the model.</li><li>era<em>year</em>input: Year of the ERA5 time series to be used in the model.</li><li>Dataset: Matrix of countries with their corresponding GADM name.</li><li>folder: Upper most folder where the instance is being generated.</li><li>subfolder: Lower level folder where the instance is being generated.</li><li>instance: Name of the instance.</li><li>T: Time period in hours.</li><li>t: Number of technologies considered in the instance.</li><li>Fmin: Minimum water flow for node <span>$n$</span>.</li></ul><p>The country dataset gets generated by</p><pre><code class="language- hljs">julia&gt; get_countries(Regions)</code></pre><p>Where </p><ul><li>Regions: Vector with the country or region names that the user wants. Regions available are Nordics, Eastern, Western, Central, Mediterranian.</li></ul><p>This takes the countries or regions specified by the user and turns them into a structure which GlobalEnergyGIS can recognize and on base of which it creates datasets of renewable energies.</p><p>The regions contain following countries:</p><pre><code class="nohighlight hljs">Nordics: Finland, Sweden, Norway, Denmark</code></pre><pre><code class="nohighlight hljs">Eastern: Poland, Slovakia, Hungary, Lithuania, Latvia, Estonia</code></pre><pre><code class="nohighlight hljs">Western: France, United Kingdom, Ireland, Netherlands, Belgium, Luxembourg </code></pre><pre><code class="nohighlight hljs">Central: Germany, Austria, Switzerland, Czech Republic</code></pre><pre><code class="nohighlight hljs">Mediterranian: Spain, Portugal, Italy, Greece, Croatia, Malta, Albania, Bosnia and Herzegovina</code></pre><p>If the user does not specify any set of countries or regions, he will get an instance for whole Europe: </p><pre><code class="language- hljs">julia&gt; get_countries()</code></pre><p>This includes all of the following countries:</p><pre><code class="nohighlight hljs">Albania, Armenia, Austria, Azerbaijan, Belarus, Belgium, Bosnia and Herzegovina, Bulgaria, Croatia, Cyprus, Czech Republic, Denmark, Estonia, Finland, France, Germany, Greece, Hungary, Iceland, Ireland, Italy, Kosovo, Latvia, Lithuania, Luxembourg, Malta, Moldova, Montenegro, Netherlands, North Macedonia, Norway, Poland, Portugal, Romania, Russia, Serbia, Slovakia, Slovenia, Spain, Sweden, Switzerland, Turkey, Ukraine, United Kingdom</code></pre><p>The instance itself is then created by: </p><pre><code class="language- hljs">julia&gt; create_data_sets(inputdata, sspscenario_input, sspyear_input, era_year_input, Dataset, folder, subfolder, instance, T, t, Fmin)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../plotting/">« Plotting</a><a class="docs-footer-nextpage" href="../api/">API »</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="Monday 12 August 2024 10:06">Monday 12 August 2024</span>. Using Julia version 1.4.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>Data generation · EnergySystemModeling.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><link href="../assets/favicon.ico" rel="icon" type="image/x-icon"/></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../"><img src="../assets/logo.svg" alt="EnergySystemModeling.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../">EnergySystemModeling.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="../">Home</a></li><li><a class="tocitem" href="../aggreg/">Aggreg.jl</a></li><li><a class="tocitem" href="../plotting/">Plotting</a></li><li class="is-active"><a class="tocitem" href>Data generation</a><ul class="internal"><li><a class="tocitem" href="#Setup-and-data-generation-in-GlobalEnergyGIS"><span>Setup and data generation in GlobalEnergyGIS</span></a></li><li><a class="tocitem" href="#Run*data*generation.jl"><span>Run<em>data</em>generation.jl</span></a></li></ul></li><li><a class="tocitem" href="../api/">API</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>Data generation</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>Data generation</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/gamma-opt/EnergySystemModeling.jl/blob/master/docs/src/datageneration.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="Data-generation"><a class="docs-heading-anchor" href="#Data-generation">Data generation</a><a id="Data-generation-1"></a><a class="docs-heading-anchor-permalink" href="#Data-generation" title="Permalink"></a></h1><h2 id="Setup-and-data-generation-in-GlobalEnergyGIS"><a class="docs-heading-anchor" href="#Setup-and-data-generation-in-GlobalEnergyGIS">Setup and data generation in GlobalEnergyGIS</a><a id="Setup-and-data-generation-in-GlobalEnergyGIS-1"></a><a class="docs-heading-anchor-permalink" href="#Setup-and-data-generation-in-GlobalEnergyGIS" title="Permalink"></a></h2><p>If the user wants to generate completely new instances, they first need to set up GlobalEnergyGIS: https://github.com/niclasmattsson/GlobalEnergyGIS . Especially important is the first part &quot;Setup and data generation&quot;. This allows the user to create datasets of renewable energy independant of EnergySystemModeling. After the user set up their Copernicus account and downloaded the auxiliary datasets, rasterized them and downloaded ERA5 data, they can start generating their own instances in EnergySystemModeling.</p><h2 id="Run*data*generation.jl"><a class="docs-heading-anchor" href="#Run*data*generation.jl">Run<em>data</em>generation.jl</a><a id="Run*data*generation.jl-1"></a><a class="docs-heading-anchor-permalink" href="#Run*data*generation.jl" title="Permalink"></a></h2><p>After the setup of GlobalEnergyGIS, the user can create a new instance by running the run<em>data</em>generation.jl file. </p><p>The first thing the user has to do is to define the input values for the function</p><pre><code class="nohighlight hljs">julia&gt; create_data_sets(inputdata, sspscenario_input, sspyear_input, era_year_input, Dataset, folder, subfolder, instance, T, t, Fmin)</code></pre><p>These input values are:</p><ul><li>inputdata: Path to the output folder of GlobalEnergyGIS</li><li>sspscenario_input: One of three scenarios: ssp1, ssp2 or ssp3. All are scenarios of projected socioeconomic global changes up to 2100. They are used to derive greenhouse gas emissions scenarios with different climate policies.</li><li>sspyear_input: Target year of the model.</li><li>era<em>year</em>input: Year of the ERA5 time series to be used in the model.</li><li>Dataset: Matrix of countries with their corresponding GADM name.</li><li>folder: Upper most folder where the instance is being generated.</li><li>subfolder: Lower level folder where the instance is being generated.</li><li>instance: Name of the instance.</li><li>T: Time period in hours.</li><li>t: Number of technologies considered in the instance.</li><li>Fmin: Minimum water flow for node <span>$n$</span>.</li></ul><p>The country dataset gets generated by</p><pre><code class="language- hljs">julia&gt; get_countries(Regions)</code></pre><p>Where </p><ul><li>Regions: Vector with the country or region names that the user wants. Regions available are Nordics, Eastern, Western, Central, Mediterranian.</li></ul><p>This takes the countries or regions specified by the user and turns them into a structure which GlobalEnergyGIS can recognize and on base of which it creates datasets of renewable energies.</p><p>The regions contain following countries:</p><pre><code class="nohighlight hljs">Nordics: Finland, Sweden, Norway, Denmark</code></pre><pre><code class="nohighlight hljs">Eastern: Poland, Slovakia, Hungary, Lithuania, Latvia, Estonia</code></pre><pre><code class="nohighlight hljs">Western: France, United Kingdom, Ireland, Netherlands, Belgium, Luxembourg </code></pre><pre><code class="nohighlight hljs">Central: Germany, Austria, Switzerland, Czech Republic</code></pre><pre><code class="nohighlight hljs">Mediterranian: Spain, Portugal, Italy, Greece, Croatia, Malta, Albania, Bosnia and Herzegovina</code></pre><p>If the user does not specify any set of countries or regions, he will get an instance for whole Europe: </p><pre><code class="language- hljs">julia&gt; get_countries()</code></pre><p>This includes all of the following countries:</p><pre><code class="nohighlight hljs">Albania, Armenia, Austria, Azerbaijan, Belarus, Belgium, Bosnia and Herzegovina, Bulgaria, Croatia, Cyprus, Czech Republic, Denmark, Estonia, Finland, France, Germany, Greece, Hungary, Iceland, Ireland, Italy, Kosovo, Latvia, Lithuania, Luxembourg, Malta, Moldova, Montenegro, Netherlands, North Macedonia, Norway, Poland, Portugal, Romania, Russia, Serbia, Slovakia, Slovenia, Spain, Sweden, Switzerland, Turkey, Ukraine, United Kingdom</code></pre><p>The instance itself is then created by: </p><pre><code class="language- hljs">julia&gt; create_data_sets(inputdata, sspscenario_input, sspyear_input, era_year_input, Dataset, folder, subfolder, instance, T, t, Fmin)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../plotting/">« Plotting</a><a class="docs-footer-nextpage" href="../api/">API »</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="Friday 23 August 2024 08:43">Friday 23 August 2024</span>. Using Julia version 1.4.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
2 changes: 1 addition & 1 deletion dev/index.html

Large diffs are not rendered by default.

Loading

0 comments on commit b8c5149

Please sign in to comment.