build based on 91edc3f

NREL-Sienna · Nov 10, 2023 · 97f6029 · 97f6029
1 parent e64aa46
commit 97f6029
Show file tree

Hide file tree

Showing 16 changed files with 761 additions and 3 deletions.
diff --git a/stable b/stable
@@ -1 +1 @@
-v0.5.1
+v0.5.2
diff --git a/v0.5 b/v0.5
@@ -1 +1 @@
-v0.5.1
+v0.5.2
diff --git a/v0.5.2/PowerAnalytics/3.0_getting_started.jl b/v0.5.2/PowerAnalytics/3.0_getting_started.jl
@@ -0,0 +1,9 @@
+# # Getting Started with PowerAnalytics
+
+# Start by creating a results object using [PowerSimulations](http://github.com/nrel-sienna/PowerSimulations.jl.git)
+
+# Set up PowerAnalytics:
+# ```julia
+# import PowerAnalytics
+# const PA = PowerAnalytics
+# ```
diff --git a/v0.5.2/api/PowerAnalytics/index.html b/v0.5.2/api/PowerAnalytics/index.html
@@ -0,0 +1,3 @@
+<!DOCTYPE html>
+<html lang="en"><head><meta charset="UTF-8"/><meta name="viewport" content="width=device-width, initial-scale=1.0"/><title>PowerAnalytics · PowerAnalytics.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></head><body><div id="documenter"><nav class="docs-sidebar"><a class="docs-logo" href="../../"><img src="../../assets/logo.png" alt="PowerAnalytics.jl logo"/></a><div class="docs-package-name"><span class="docs-autofit"><a href="../../">PowerAnalytics.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="../../">Introduction</a></li><li><span class="tocitem">API</span><ul><li class="is-active"><a class="tocitem" href>PowerAnalytics</a><ul class="internal"><li><a class="tocitem" href="#Index"><span>Index</span></a></li><li><a class="tocitem" href="#Exported"><span>Exported</span></a></li><li><a class="tocitem" href="#Internal"><span>Internal</span></a></li></ul></li></ul></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><a class="is-disabled">API</a></li><li class="is-active"><a href>PowerAnalytics</a></li></ul><ul class="is-hidden-tablet"><li class="is-active"><a href>PowerAnalytics</a></li></ul></nav><div class="docs-right"><a class="docs-edit-link" href="https://github.com/NREL-Sienna/PowerAnalytics.jl/blob/main/docs/src/api/PowerAnalytics.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="PowerAnalytics"><a class="docs-heading-anchor" href="#PowerAnalytics">PowerAnalytics</a><a id="PowerAnalytics-1"></a><a class="docs-heading-anchor-permalink" href="#PowerAnalytics" title="Permalink"></a></h1><p>API documentation</p><ul><li><a href="#PowerAnalytics">PowerAnalytics</a></li><li class="no-marker"><ul><li><a href="#Index">Index</a></li><li><a href="#Exported">Exported</a></li><li><a href="#Internal">Internal</a></li></ul></li></ul><h2 id="Index"><a class="docs-heading-anchor" href="#Index">Index</a><a id="Index-1"></a><a class="docs-heading-anchor-permalink" href="#Index" title="Permalink"></a></h2><ul><li><a href="#PowerAnalytics.categorize_data-Tuple{Dict{Symbol, DataFrames.DataFrame}, Dict}"><code>PowerAnalytics.categorize_data</code></a></li><li><a href="#PowerAnalytics.combine_categories-Tuple{Union{Dict{String, DataFrames.DataFrame}, Dict{Symbol, DataFrames.DataFrame}}}"><code>PowerAnalytics.combine_categories</code></a></li><li><a href="#PowerAnalytics.get_generator_category-Tuple{Any, Any, Any, Any, Dict{NamedTuple, String}}"><code>PowerAnalytics.get_generator_category</code></a></li><li><a href="#PowerAnalytics.get_generator_mapping"><code>PowerAnalytics.get_generator_mapping</code></a></li><li><a href="#PowerAnalytics.make_fuel_dictionary-Tuple{PowerSystems.System, Dict{NamedTuple, String}}"><code>PowerAnalytics.make_fuel_dictionary</code></a></li></ul><h2 id="Exported"><a class="docs-heading-anchor" href="#Exported">Exported</a><a id="Exported-1"></a><a class="docs-heading-anchor-permalink" href="#Exported" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="PowerAnalytics.categorize_data-Tuple{Dict{Symbol, DataFrames.DataFrame}, Dict}" href="#PowerAnalytics.categorize_data-Tuple{Dict{Symbol, DataFrames.DataFrame}, Dict}"><code>PowerAnalytics.categorize_data</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Re-categorizes data according to an aggregation dictionary</p><ul><li>makes no guarantee of complete data collection *</li></ul><p><strong>Example</strong></p><pre><code class="language-julia hljs">aggregation = PA.make_fuel_dictionary(results_uc.system)
+categorize_data(gen_uc.data, aggregation)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerAnalytics.jl/blob/91edc3f8095ec6a3af6c223d2add61ccda775326/src/get_data.jl#L530-L541">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PowerAnalytics.make_fuel_dictionary-Tuple{PowerSystems.System, Dict{NamedTuple, String}}" href="#PowerAnalytics.make_fuel_dictionary-Tuple{PowerSystems.System, Dict{NamedTuple, String}}"><code>PowerAnalytics.make_fuel_dictionary</code></a> — <span class="docstring-category">Method</span></header><section><div><pre><code class="language-julia hljs">generators = make_fuel_dictionary(system::PSY.System, mapping::Dict{NamedTuple, String})</code></pre><p>This function makes a dictionary of fuel type and the generators associated.</p><p><strong>Arguments</strong></p><ul><li><code>sys::PSY.System</code>: the system that is used to create the results</li><li><code>results::IS.Results</code>: results</li></ul><p><strong>Key Words</strong></p><ul><li><code>categories::Dict{String, NamedTuple}</code>: if stacking by a different category is desired</li></ul><p><strong>Example</strong></p><p>results = solve<em>op</em>model!(OpModel) generators = make<em>fuel</em>dictionary(sys)</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerAnalytics.jl/blob/91edc3f8095ec6a3af6c223d2add61ccda775326/src/fuel_results.jl#L66-L82">source</a></section></article><h2 id="Internal"><a class="docs-heading-anchor" href="#Internal">Internal</a><a id="Internal-1"></a><a class="docs-heading-anchor-permalink" href="#Internal" title="Permalink"></a></h2><article class="docstring"><header><a class="docstring-binding" id="PowerAnalytics.combine_categories-Tuple{Union{Dict{String, DataFrames.DataFrame}, Dict{Symbol, DataFrames.DataFrame}}}" href="#PowerAnalytics.combine_categories-Tuple{Union{Dict{String, DataFrames.DataFrame}, Dict{Symbol, DataFrames.DataFrame}}}"><code>PowerAnalytics.combine_categories</code></a> — <span class="docstring-category">Method</span></header><section><div><p>aggregates and combines data into single DataFrame</p><p><strong>Example</strong></p><pre><code class="language-julia hljs">PG.combine_categories(gen_uc.data)</code></pre></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerAnalytics.jl/blob/91edc3f8095ec6a3af6c223d2add61ccda775326/src/get_data.jl#L499-L508">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PowerAnalytics.get_generator_category-Tuple{Any, Any, Any, Any, Dict{NamedTuple, String}}" href="#PowerAnalytics.get_generator_category-Tuple{Any, Any, Any, Any, Dict{NamedTuple, String}}"><code>PowerAnalytics.get_generator_category</code></a> — <span class="docstring-category">Method</span></header><section><div><p>Return the generator category for this fuel and unit_type.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerAnalytics.jl/blob/91edc3f8095ec6a3af6c223d2add61ccda775326/src/fuel_results.jl#L33">source</a></section></article><article class="docstring"><header><a class="docstring-binding" id="PowerAnalytics.get_generator_mapping" href="#PowerAnalytics.get_generator_mapping"><code>PowerAnalytics.get_generator_mapping</code></a> — <span class="docstring-category">Function</span></header><section><div><p>Return a dict where keys are a tuple of input parameters (fuel, unit_type) and values are generator types.</p></div><a class="docs-sourcelink" target="_blank" href="https://github.com/NREL-Sienna/PowerAnalytics.jl/blob/91edc3f8095ec6a3af6c223d2add61ccda775326/src/fuel_results.jl#L1-L3">source</a></section></article></article><nav class="docs-footer"><a class="docs-footer-prevpage" href="../../">« Introduction</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 10 November 2023 19:06">Friday 10 November 2023</span>. Using Julia version 1.9.3.</p></section><footer class="modal-card-foot"></footer></div></div></div></body></html>