build based on e609219

previews/PR316/dev_guide/components_and_container/index.html

@@ -6,4 +6,4 @@
 # Optional
 get_ext(c::MyComponent) = InfrastructureSystems.get_ext(c.ext)
 clear_ext!(c::MyComponent) = InfrastructureSystems.clear_ext(c.ext)</code></pre><p><em>Notes</em>:</p><ul><li><a href="../../InfrastructureSystems/#InfrastructureSystems.get_uuid-Tuple{InfrastructureSystems.InfrastructureSystemsType}"><code>InfrastructureSystems.get_uuid</code></a> with argument <code>obj::InfrastructureSystemsComponent</code> returns the component UUID.</li><li>The extension dictionary is not created until the first time <code>get_ext</code> is called.</li></ul><h2 id="Interface-requirements"><a class="docs-heading-anchor" href="#Interface-requirements">Interface requirements</a><a id="Interface-requirements-1"></a><a class="docs-heading-anchor-permalink" href="#Interface-requirements" title="Permalink"></a></h2><p>Implement these methods for every struct.</p><ul><li><code>get_internal(c::MyComponent)::InfrastructureSystemsInternal</code></li><li><code>get_name(c::MyComponent)::String</code></li></ul><p>If the struct stores time series data:</p><ul><li><code>get_time_series_container(c::MyComponent)::TimeSeriesContainer</code></li></ul><h2 id="Component-Container"><a class="docs-heading-anchor" href="#Component-Container">Component Container</a><a id="Component-Container-1"></a><a class="docs-heading-anchor-permalink" href="#Component-Container" title="Permalink"></a></h2><p><code>InfrastructureSystems.jl</code> provides the <code>SystemData</code> struct to store a collection of components.</p><p>It is recommended but not required that you include this struct within your own system struct for these reasons:</p><ul><li>Provides search and iteration with <a href="../../InfrastructureSystems/#InfrastructureSystems.get_component-Union{Tuple{T}, Tuple{Type{T}, InfrastructureSystems.Components, AbstractString}} where T&lt;:InfrastructureSystems.InfrastructureSystemsComponent"><code>InfrastructureSystems.get_component</code></a> and <a href="../../InfrastructureSystems/#InfrastructureSystems.get_components-Union{Tuple{T}, Tuple{Type{T}, InfrastructureSystems.Components}, Tuple{Type{T}, InfrastructureSystems.Components, Union{Nothing, Function}}} where T&lt;:InfrastructureSystems.InfrastructureSystemsComponent"><code>InfrastructureSystems.get_components</code></a> for abstract and concrete types.</li><li>Enforces name uniqueness within a concrete type.</li><li>Allows for component field validation.</li><li>Enables component JSON serialization and deserialization.</li></ul><h2 id="Instructions-on-how-to-use-the-SystemData-container"><a class="docs-heading-anchor" href="#Instructions-on-how-to-use-the-SystemData-container">Instructions on how to use the <code>SystemData</code> container</a><a id="Instructions-on-how-to-use-the-SystemData-container-1"></a><a class="docs-heading-anchor-permalink" href="#Instructions-on-how-to-use-the-SystemData-container" title="Permalink"></a></h2><ol><li>Add an instance of <code>SystemData</code> to your system struct.</li><li>Optionally pass a component validation descriptor file to the constructor.</li><li>Optionally pass <code>time_series_in_memory = true</code> to the constructor if you know that all time series data will fit in memory and want a performance boost.</li><li>Redirect these function calls to your instance of SystemData.</li></ol><ul><li><code>add_component!</code></li><li><code>remove_component!</code></li><li><code>get_component</code></li><li><code>get_components</code></li><li><code>get_components_by_name</code></li><li><code>add_time_series!</code></li></ul><h2 id="Importing-InfrastructureSystems-methods"><a class="docs-heading-anchor" href="#Importing-InfrastructureSystems-methods">Importing InfrastructureSystems methods</a><a id="Importing-InfrastructureSystems-methods-1"></a><a class="docs-heading-anchor-permalink" href="#Importing-InfrastructureSystems-methods" title="Permalink"></a></h2><p>It is recommended that you perform redirection on methods that act on <code>SystemData</code> so that those methods don&#39;t show up in <code>Julia</code> help or in <code>methods</code> output. For example:</p><pre><code class="language-julia">get_time_series_resolution(sys::MySystem) =
-    InfrastructureSystems.get_time_series_resolution(sys.data)</code></pre><p>On the other hand, it is recommended that you import methods that act on an <code>InfrastructureSystemsComponent</code> into your package&#39;s namespace so that you don&#39;t have to duplicate docstrings and perform redirection. For example:</p><pre><code class="language-julia">import InfrastructureSystems: get_time_series</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Welcome Page</a><a class="docs-footer-nextpage" href="../auto_generation/">Auto-Generation of Component Structs »</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> on <span class="colophon-date" title="Tuesday 12 December 2023 03:29">Tuesday 12 December 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+    InfrastructureSystems.get_time_series_resolution(sys.data)</code></pre><p>On the other hand, it is recommended that you import methods that act on an <code>InfrastructureSystemsComponent</code> into your package&#39;s namespace so that you don&#39;t have to duplicate docstrings and perform redirection. For example:</p><pre><code class="language-julia">import InfrastructureSystems: get_time_series</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Welcome Page</a><a class="docs-footer-nextpage" href="../auto_generation/">Auto-Generation of Component Structs »</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> on <span class="colophon-date" title="Tuesday 12 December 2023 04:10">Tuesday 12 December 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR316/dev_guide/logging/index.html

@@ -70,4 +70,4 @@
     @info "hello" maxlog = 2
     @warn "beware" maxlog = 2
 end
-@info report_log_summary(logger)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tests/">« Running Tests</a><a class="docs-footer-nextpage" href="../../style/">Style Guide »</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> on <span class="colophon-date" title="Tuesday 12 December 2023 03:29">Tuesday 12 December 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+@info report_log_summary(logger)</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../tests/">« Running Tests</a><a class="docs-footer-nextpage" href="../../style/">Style Guide »</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> on <span class="colophon-date" title="Tuesday 12 December 2023 04:10">Tuesday 12 December 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR316/dev_guide/tests/index.html

@@ -3,4 +3,4 @@
 julia&gt; include(&quot;test/runtests.jl&quot;)</code></pre><ul><li>Change logging level(s):</li></ul><pre><code class="language-julia">julia&gt; IS.make_logging_config_file(&quot;logging_config.toml&quot;)
 julia&gt; ENV[&quot;SIIP_LOGGING_CONFIG&quot;] = &quot;logging_config.toml&quot;
 # Edit the file to suit your preferences.
-julia&gt; include(&quot;test/runtests.jl&quot;)</code></pre><p><strong>Note</strong> that you can filter out noisy log groups in this file.</p><p>The unit test module appends a summary of all log message counts to the log file.  If a message is logged too frequently then consider tagging that message with maxlog=X to suppress it.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../recorder/">« Recorder Events</a><a class="docs-footer-nextpage" href="../logging/">Logging »</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> on <span class="colophon-date" title="Tuesday 12 December 2023 03:29">Tuesday 12 December 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+julia&gt; include(&quot;test/runtests.jl&quot;)</code></pre><p><strong>Note</strong> that you can filter out noisy log groups in this file.</p><p>The unit test module appends a summary of all log message counts to the log file.  If a message is logged too frequently then consider tagging that message with maxlog=X to suppress it.</p></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../recorder/">« Recorder Events</a><a class="docs-footer-nextpage" href="../logging/">Logging »</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> on <span class="colophon-date" title="Tuesday 12 December 2023 04:10">Tuesday 12 December 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>

previews/PR316/dev_guide/time_series/index.html

@@ -7,4 +7,4 @@
             0b6ecb61-8e8d-4563-b795-f001246c3ea5__max_active_power
             613ddbc2-b666-4c9d-adb5-fa69e7f40a95__max_active_power
         /data</code></pre><h2 id="Debugging"><a class="docs-heading-anchor" href="#Debugging">Debugging</a><a id="Debugging-1"></a><a class="docs-heading-anchor-permalink" href="#Debugging" title="Permalink"></a></h2><p>The HDF Group provides tools to inspect and manipulate files. Refer to their <a href="https://support.hdfgroup.org/products/hdf5_tools/">website</a>.</p><p><code>HDFView</code> is especially useful for viewing data. Note that using <code>h5ls</code> and <code>h5dump</code> in a terminal combined with UNIX tools like <code>grep</code> can sometimes be faster.</p><h2 id="Maintenance"><a class="docs-heading-anchor" href="#Maintenance">Maintenance</a><a id="Maintenance-1"></a><a class="docs-heading-anchor-permalink" href="#Maintenance" title="Permalink"></a></h2><p>If you delete time series arrays in your system you may notice that the actual size of the HDF5 does not decrease. The only way to recover this space is to build a new file with only the active objects. The HDF5 tools package provides the tool <code>h5repack</code> for this purpose.</p><pre><code class="language-bash">$ h5repack time_series.h5 new.h5
-$ mv new.h5 time_series.h5</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../auto_generation/">« Auto-Generation of Component Structs</a><a class="docs-footer-nextpage" href="../recorder/">Recorder Events »</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> on <span class="colophon-date" title="Tuesday 12 December 2023 03:29">Tuesday 12 December 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>
+$ mv new.h5 time_series.h5</code></pre></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../auto_generation/">« Auto-Generation of Component Structs</a><a class="docs-footer-nextpage" href="../recorder/">Recorder Events »</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> on <span class="colophon-date" title="Tuesday 12 December 2023 04:10">Tuesday 12 December 2023</span>. Using Julia version 1.6.7.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>