build based on 5d26c1d

previews/PR175/examples/custom_study/index.html

@@ -50,4 +50,4 @@
         )
     )
 )
-</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../modification/">« Modifying a Study</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="Wednesday 9 August 2023 21:04">Wednesday 9 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../modification/">« Modifying a Study</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 18 August 2023 18:01">Friday 18 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR175/examples/graf_files/index.html

@@ -156,4 +156,4 @@
         "Duracao",
         Float64,
         filters = ["test_filter"]
-    )</code></pre><p>Then, when we run:</p><pre><code class="language- hljs">PSRI.update_vectors!(data, &quot;test_filter&quot;)</code></pre><h2 id="Comparison-between-a-GrafTable-and-a-SeriesTable"><a class="docs-heading-anchor" href="#Comparison-between-a-GrafTable-and-a-SeriesTable">Comparison between a GrafTable and a SeriesTable</a><a id="Comparison-between-a-GrafTable-and-a-SeriesTable-1"></a><a class="docs-heading-anchor-permalink" href="#Comparison-between-a-GrafTable-and-a-SeriesTable" title="Permalink"></a></h2><p>In this section we have introduced some new concepts about table-like types. That being said, let&#39;s review the main differences between GrafTables and SeriesTables:</p><ul><li>SeriesTable<ul><li>Is linked to a single element from a collection</li><li>It can have time series of different attributes that are indexed to a single attribute (all belonging to the same element)</li></ul></li><li>GrafTable<ul><li>Is linked to the whole collection. So for an attribute, every element in the collection will have an entry in the graf file</li><li>It has the time series for only one attribute</li></ul></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../reading_relations/">« Reading Relations</a><a class="docs-footer-nextpage" href="../reading_demands/">Reading Demands »</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="Wednesday 9 August 2023 21:04">Wednesday 9 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+    )</code></pre><p>Then, when we run:</p><pre><code class="language- hljs">PSRI.update_vectors!(data, &quot;test_filter&quot;)</code></pre><h2 id="Comparison-between-a-GrafTable-and-a-SeriesTable"><a class="docs-heading-anchor" href="#Comparison-between-a-GrafTable-and-a-SeriesTable">Comparison between a GrafTable and a SeriesTable</a><a id="Comparison-between-a-GrafTable-and-a-SeriesTable-1"></a><a class="docs-heading-anchor-permalink" href="#Comparison-between-a-GrafTable-and-a-SeriesTable" title="Permalink"></a></h2><p>In this section we have introduced some new concepts about table-like types. That being said, let&#39;s review the main differences between GrafTables and SeriesTables:</p><ul><li>SeriesTable<ul><li>Is linked to a single element from a collection</li><li>It can have time series of different attributes that are indexed to a single attribute (all belonging to the same element)</li></ul></li><li>GrafTable<ul><li>Is linked to the whole collection. So for an attribute, every element in the collection will have an entry in the graf file</li><li>It has the time series for only one attribute</li></ul></li></ul></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../reading_relations/">« Reading Relations</a><a class="docs-footer-nextpage" href="../reading_demands/">Reading Demands »</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 18 August 2023 18:01">Friday 18 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR175/examples/modification/index.html

@@ -33,4 +33,4 @@
     bus_2_index , 
     relation_type = PSRI.PMD.RELATION_TO
     )</code></pre><h2 id="Deleting-elements"><a class="docs-heading-anchor" href="#Deleting-elements">Deleting elements</a><a id="Deleting-elements-1"></a><a class="docs-heading-anchor-permalink" href="#Deleting-elements" title="Permalink"></a></h2><p>We can delete an element using <a href="examples/@ref"><code>PSRI.delete_element!</code></a>. </p><pre><code class="nohighlight hljs">PSRI.delete_element!(data, &quot;PSRBus&quot;, bus_3_index)</code></pre><p>However, if you try to delete an element that has a relation with any other, you will receive an error message. </p><pre><code class="nohighlight hljs">PSRI.delete_element!(data, &quot;PSRSerie&quot;, serie_1_index)</code></pre><blockquote><p>&lt;span style=&quot;color:red&quot;&gt;ERROR:&lt;/span&gt; Element PSRSerie cannot be deleted because it has relations with other elements</p></blockquote><p>So first, you have to check the relations that the element has and delete them.</p><p>To see the relations set to an element, use <a href="examples/@ref"><code>PSRI.relations_summary</code></a>, which returns a list with the <code>target</code> element, with its index, pointing to the <code>source</code> element, also with its index.</p><pre><code class="nohighlight hljs">PSRI.relations_summary(data, &quot;PSRBus&quot;, bus_1_index)</code></pre><blockquote><p>1: PSRBus[1] ← PSRSerie[1]</p></blockquote><pre><code class="nohighlight hljs">PSRI.relations_summary(data, &quot;PSRBus&quot;, bus_2_index)</code></pre><blockquote><p>1: PSRBus[2] ← PSRSerie[1]</p></blockquote><pre><code class="nohighlight hljs">PSRI.relations_summary(data, &quot;PSRSerie&quot;, serie_1_index)</code></pre><blockquote><p>1: PSRSerie[1] → PSRBus[1] </p><p>2: PSRSerie[1] → PSRBus[2]</p></blockquote><p>Now we know that we have to delete two relations to be able to delete the <code>PSRSerie</code> element. For that, we use <a href="examples/@ref"><code>PSRI.delete_relation!</code></a>.</p><pre><code class="nohighlight hljs">PSRI.delete_relation!(data, &quot;PSRSerie&quot;, &quot;PSRBus&quot;, serie_1_index, bus_1_index)
-PSRI.delete_relation!(data, &quot;PSRSerie&quot;, &quot;PSRBus&quot;, serie_1_index, bus_2_index)</code></pre><p>After that, we can easily delete our <code>PSRSerie</code> element.</p><pre><code class="nohighlight hljs">PSRI.delete_element!(data, &quot;PSRSerie&quot;, serie_1_index)</code></pre><p>After that we can save our study to a JSON file, which can later be used to load the study again.</p><pre><code class="nohighlight hljs">PSRI.write_data(data)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../reading_demands/">« Reading Demands</a><a class="docs-footer-nextpage" href="../custom_study/">Customizing a Study »</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="Wednesday 9 August 2023 21:03">Wednesday 9 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+PSRI.delete_relation!(data, &quot;PSRSerie&quot;, &quot;PSRBus&quot;, serie_1_index, bus_2_index)</code></pre><p>After that, we can easily delete our <code>PSRSerie</code> element.</p><pre><code class="nohighlight hljs">PSRI.delete_element!(data, &quot;PSRSerie&quot;, serie_1_index)</code></pre><p>After that we can save our study to a JSON file, which can later be used to load the study again.</p><pre><code class="nohighlight hljs">PSRI.write_data(data)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../reading_demands/">« Reading Demands</a><a class="docs-footer-nextpage" href="../custom_study/">Customizing a Study »</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 18 August 2023 18:01">Friday 18 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR175/examples/reading_demands/index.html

@@ -131,4 +131,4 @@
  [20.0]
  [40.0]
  [60.0]
- [80.0]</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../graf_files/">« Graf Files and Time Series</a><a class="docs-footer-nextpage" href="../modification/">Modifying a Study »</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="Wednesday 9 August 2023 21:04">Wednesday 9 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+ [80.0]</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../graf_files/">« Graf Files and Time Series</a><a class="docs-footer-nextpage" href="../modification/">Modifying a Study »</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 18 August 2023 18:01">Friday 18 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR175/examples/reading_parameters/index.html

@@ -52,4 +52,4 @@
 batteries.names = PSRI.get_name(data, "PSRBattery")
 batteries.codes = PSRI.get_code(data, "PSRBattery")
 batteries.charge_eff = PSRI.mapped_vector(data, "PSRBattery", "ChargeEffic", Float64)
-batteries.bat2sys = PSRI.get_map(data, &quot;PSRBattery&quot;, &quot;PSRSystem&quot;)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../file_types/psrclasses/">« psrclasses.json and Defaults</a><a class="docs-footer-nextpage" href="../reading_relations/">Reading Relations »</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="Wednesday 9 August 2023 21:04">Wednesday 9 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+batteries.bat2sys = PSRI.get_map(data, &quot;PSRBattery&quot;, &quot;PSRSystem&quot;)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../file_types/psrclasses/">« psrclasses.json and Defaults</a><a class="docs-footer-nextpage" href="../reading_relations/">Reading Relations »</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 18 August 2023 18:01">Friday 18 August 2023</span>. Using Julia version 1.9.2.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>