adding major doc changes

ebalogun01 · Dec 19, 2023 · 0e59106 · 0e59106
1 parent c59b1ee
commit 0e59106
Show file tree

Hide file tree

Showing 117 changed files with 2,729 additions and 2,019 deletions.
diff --git a/__init__.py b/__init__.py
diff --git a/docs/build/doctrees/EV-EcoSim.analysis.cost_analysis.doctree b/docs/build/doctrees/EV-EcoSim.analysis.cost_analysis.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.analysis.doctree b/docs/build/doctrees/EV-EcoSim.analysis.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.analysis.load_post_opt_costs.doctree b/docs/build/doctrees/EV-EcoSim.analysis.load_post_opt_costs.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.analysis.plot_results.doctree b/docs/build/doctrees/EV-EcoSim.analysis.plot_results.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.app.doctree b/docs/build/doctrees/EV-EcoSim.app.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.batt_sys_identification.battery_identification.doctree b/docs/build/doctrees/EV-EcoSim.batt_sys_identification.battery_identification.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.batt_sys_identification.doctree b/docs/build/doctrees/EV-EcoSim.batt_sys_identification.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.batt_sys_identification.experiments.doctree b/docs/build/doctrees/EV-EcoSim.batt_sys_identification.experiments.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.battery.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.battery.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.batteryAgingSim.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.batteryAgingSim.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.batterypack.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.batterypack.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.batterytest.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.batterytest.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.capacitor.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.capacitor.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.chargingStation.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.chargingStation.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.clock.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.clock.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.controller.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.controller.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.electricityPrices.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.electricityPrices.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.node.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.node.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.optimization.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.optimization.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.orchestrator.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.orchestrator.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.simulate.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.simulate.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.solar.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.solar.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.transformer.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.transformer.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.charging_sim.utils.doctree b/docs/build/doctrees/EV-EcoSim.charging_sim.utils.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.doctree b/docs/build/doctrees/EV-EcoSim.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.setup.doctree b/docs/build/doctrees/EV-EcoSim.setup.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.base_case.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.base_case.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.base_case.event_handlers.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.base_case.event_handlers.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.base_case.feeder_population.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.base_case.feeder_population.doctree
diff --git a/...build/doctrees/EV-EcoSim.test_cases.base_case.feeder_population.feeder_population.doctree b/...build/doctrees/EV-EcoSim.test_cases.base_case.feeder_population.feeder_population.doctree
diff --git a/...build/doctrees/EV-EcoSim.test_cases.base_case.feeder_population.glm_mod_functions.doctree b/...build/doctrees/EV-EcoSim.test_cases.base_case.feeder_population.glm_mod_functions.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.base_case.gblvar.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.base_case.gblvar.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.base_case.glmptime.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.base_case.glmptime.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.base_case.master_sim.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.base_case.master_sim.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.base_case.sim.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.base_case.sim.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.base_case.voltdump2.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.base_case.voltdump2.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.battery.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.battery.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.battery.event_handlers.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.battery.event_handlers.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.battery.event_handlers_oneshot.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.battery.event_handlers_oneshot.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.battery.feeder_population.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.battery.feeder_population.doctree
diff --git a/...rees/EV-EcoSim.test_cases.battery.feeder_population.feeder_population_centralized.doctree b/...rees/EV-EcoSim.test_cases.battery.feeder_population.feeder_population_centralized.doctree
diff --git a/...trees/EV-EcoSim.test_cases.battery.feeder_population.feeder_population_collocated.doctree b/...trees/EV-EcoSim.test_cases.battery.feeder_population.feeder_population_collocated.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.battery.feeder_population.glm_mod_functions.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.battery.feeder_population.glm_mod_functions.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.battery.gblvar.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.battery.gblvar.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.battery.glmptime.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.battery.glmptime.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.battery.master_sim.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.battery.master_sim.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.battery.parse_voltages.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.battery.parse_voltages.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.battery.scenarios.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.battery.scenarios.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.battery.sim.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.battery.sim.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.battery.voltdump2.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.battery.voltdump2.doctree
diff --git a/docs/build/doctrees/EV-EcoSim.test_cases.doctree b/docs/build/doctrees/EV-EcoSim.test_cases.doctree
diff --git a/docs/build/doctrees/analysis.doctree b/docs/build/doctrees/analysis.doctree
diff --git a/docs/build/doctrees/app.doctree b/docs/build/doctrees/app.doctree
diff --git a/docs/build/doctrees/batt_sys_identification.doctree b/docs/build/doctrees/batt_sys_identification.doctree
diff --git a/docs/build/doctrees/charging_sim.doctree b/docs/build/doctrees/charging_sim.doctree
diff --git a/docs/build/doctrees/environment.pickle b/docs/build/doctrees/environment.pickle
diff --git a/docs/build/doctrees/feeder_population.doctree b/docs/build/doctrees/feeder_population.doctree
diff --git a/docs/build/doctrees/index.doctree b/docs/build/doctrees/index.doctree
diff --git a/docs/build/doctrees/modules.doctree b/docs/build/doctrees/modules.doctree
diff --git a/docs/build/doctrees/test_cases.base_case.doctree b/docs/build/doctrees/test_cases.base_case.doctree
diff --git a/docs/build/doctrees/test_cases.base_case.feeder_population.doctree b/docs/build/doctrees/test_cases.base_case.feeder_population.doctree
diff --git a/docs/build/doctrees/test_cases.battery.doctree b/docs/build/doctrees/test_cases.battery.doctree
diff --git a/docs/build/doctrees/test_cases.battery.feeder_population.doctree b/docs/build/doctrees/test_cases.battery.feeder_population.doctree
diff --git a/docs/build/doctrees/test_cases.doctree b/docs/build/doctrees/test_cases.doctree
diff --git a/docs/build/html/.buildinfo b/docs/build/html/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: d2818b43aaa817c7ba4286347de5a661
+config: 895b12379e5113f564136938fa044804
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/docs/build/html/Introduction/welcome.html b/docs/build/html/Introduction/welcome.html
@@ -54,6 +54,10 @@
 </ul>
 <ul>
 <li class="toctree-l1"><a class="reference internal" href="../tutorials/tutorial.html">Tutorial</a></li>
+</ul>
+<p class="caption" role="heading"><span class="caption-text">Modules</span></p>
+<ul>
+<li class="toctree-l1"><a class="reference internal" href="../modules.html">Packages</a></li>
 </ul>
 
         </div>

diff --git a/docs/build/html/_sources/analysis.rst.txt b/docs/build/html/_sources/analysis.rst.txt
@@ -1,6 +1,14 @@
 Post-simulation Analysis
 ================
 
+Module contents
+---------------
+
+.. automodule:: analysis
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Submodules
 ----------
 
@@ -28,10 +36,3 @@ analysis.plot\_results module
    :undoc-members:
    :show-inheritance:
 
-Module contents
----------------
-
-.. automodule:: analysis
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/build/html/_sources/app.rst.txt b/docs/build/html/_sources/app.rst.txt
@@ -1,4 +1,4 @@
-app module
+App - runs the platform
 ==========
 
 .. automodule:: app

diff --git a/docs/build/html/_sources/batt_sys_identification.rst.txt b/docs/build/html/_sources/batt_sys_identification.rst.txt
@@ -1,6 +1,14 @@
 Battery System Identification
 =================================
 
+Module contents
+---------------
+
+.. automodule:: batt_sys_identification
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Submodules
 ----------
 
@@ -20,10 +28,5 @@ experiments module
    :undoc-members:
    :show-inheritance:
 
-Module contents
----------------
 
-.. automodule:: batt_sys_identification
-   :members:
-   :undoc-members:
-   :show-inheritance:
+
diff --git a/docs/build/html/_sources/charging_sim.rst.txt b/docs/build/html/_sources/charging_sim.rst.txt
@@ -1,141 +1,135 @@
-Charging Simulator
+Charging Sim
 =====================
 
+Module contents
+---------------
+
+.. automodule:: charging_sim
+   :members:
+   :undoc-members:
+   :show-inheritance:
+
 Submodules
 ----------
 
-charging\_sim.battery module
+Battery module
 ----------------------------
 
 .. automodule:: charging_sim.battery
    :members:
    :undoc-members:
    :show-inheritance:
 
-charging\_sim.batteryAgingSim module
+Battery Aging Sim module
 ------------------------------------
 
 .. automodule:: charging_sim.batteryAgingSim
    :members:
    :undoc-members:
    :show-inheritance:
 
-charging\_sim.batterypack module
+Battery pack module
 --------------------------------
 
 .. automodule:: charging_sim.batterypack
    :members:
    :undoc-members:
    :show-inheritance:
 
-charging\_sim.batterytest module
---------------------------------
-
-.. automodule:: charging_sim.batterytest
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
-charging\_sim.capacitor module
+Capacitor module
 ------------------------------
 
 .. automodule:: charging_sim.capacitor
    :members:
    :undoc-members:
    :show-inheritance:
 
-charging\_sim.chargingStation module
+Charging Station module
 ------------------------------------
 
 .. automodule:: charging_sim.chargingStation
    :members:
    :undoc-members:
    :show-inheritance:
 
-charging\_sim.clock module
+Clock module
 --------------------------
 
 .. automodule:: charging_sim.clock
    :members:
    :undoc-members:
    :show-inheritance:
 
-charging\_sim.controller module
+Controller module
 -------------------------------
 
 .. automodule:: charging_sim.controller
    :members:
    :undoc-members:
    :show-inheritance:
 
-charging\_sim.electricityPrices module
+Electricity prices module
 --------------------------------------
 
 .. automodule:: charging_sim.electricityPrices
    :members:
    :undoc-members:
    :show-inheritance:
 
-charging\_sim.node module
+Node module
 -------------------------
 
 .. automodule:: charging_sim.node
    :members:
    :undoc-members:
    :show-inheritance:
 
-charging\_sim.optimization module
+Optimization module
 ---------------------------------
 
 .. automodule:: charging_sim.optimization
    :members:
    :undoc-members:
    :show-inheritance:
 
-charging\_sim.orchestrator module
+Orchestrator module
 ---------------------------------
 
 .. automodule:: charging_sim.orchestrator
    :members:
    :undoc-members:
    :show-inheritance:
 
-charging\_sim.simulate module
+Simulate module
 -----------------------------
 
 .. automodule:: charging_sim.simulate
    :members:
    :undoc-members:
    :show-inheritance:
 
-charging\_sim.solar module
+Solar module
 --------------------------
 
 .. automodule:: charging_sim.solar
    :members:
    :undoc-members:
    :show-inheritance:
 
-charging\_sim.transformer module
+Transformer module
 --------------------------------
 
 .. automodule:: charging_sim.transformer
    :members:
    :undoc-members:
    :show-inheritance:
 
-charging\_sim.utils module
+Utils
 --------------------------
 
 .. automodule:: charging_sim.utils
    :members:
    :undoc-members:
    :show-inheritance:
 
-Module contents
----------------
 
-.. automodule:: charging_sim
-   :members:
-   :undoc-members:
-   :show-inheritance:
diff --git a/docs/build/html/_sources/index.rst.txt b/docs/build/html/_sources/index.rst.txt
@@ -48,7 +48,7 @@ Links
 
 .. toctree::
     :hidden:
-    :maxdepth: 1
+    :maxdepth: 4
     :caption: Modules
 
     modules

diff --git a/docs/build/html/_sources/modules.rst.txt b/docs/build/html/_sources/modules.rst.txt
@@ -4,9 +4,9 @@ Packages
 .. toctree::
    :maxdepth: 4
 
-   analysis
-   batt_sys_identification
    charging_sim
-   feeder_population
-   setup
+   batt_sys_identification
    test_cases
+   analysis
+   app
+
diff --git a/docs/build/html/_sources/test_cases.base_case.rst.txt b/docs/build/html/_sources/test_cases.base_case.rst.txt
@@ -1,6 +1,14 @@
-Base Case Test Cases
+Base test case
 ==============================
 
+Subpackages
+-----------
+
+.. toctree::
+   :maxdepth: 4
+
+   test_cases.base_case.feeder_population
+
 Submodules
 ----------
 

diff --git a/docs/build/html/_sources/test_cases.battery.feeder_population.rst.txt b/docs/build/html/_sources/test_cases.battery.feeder_population.rst.txt
@@ -1,15 +1,6 @@
-test\_cases.battery.feeder\_population package
+Battery test case feeder population
 ==============================================
 
-
-Module contents
----------------
-
-.. automodule:: test_cases.battery.feeder_population
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 Submodules
 ----------
 
@@ -37,3 +28,10 @@ test\_cases.battery.feeder\_population.glm\_mod\_functions module
    :undoc-members:
    :show-inheritance:
 
+Module contents
+---------------
+
+.. automodule:: test_cases.battery.feeder_population
+   :members:
+   :undoc-members:
+   :show-inheritance:
diff --git a/docs/build/html/_sources/test_cases.battery.rst.txt b/docs/build/html/_sources/test_cases.battery.rst.txt
@@ -1,4 +1,4 @@
-Battery Test Cases
+Battery test Case
 ===========================
 
 Module contents
@@ -9,7 +9,6 @@ Module contents
    :undoc-members:
    :show-inheritance:
 
-
 Subpackages
 -----------
 
@@ -77,14 +76,6 @@ test\_cases.battery.scenarios module
    :undoc-members:
    :show-inheritance:
 
-test\_cases.battery.sim module
-------------------------------
-
-.. automodule:: test_cases.battery.sim
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 test\_cases.battery.voltdump2 module
 ------------------------------------
 

diff --git a/docs/build/html/_sources/test_cases.rst.txt b/docs/build/html/_sources/test_cases.rst.txt
@@ -1,14 +1,6 @@
 Test cases
 ===================
 
-Module contents
----------------
-
-.. automodule:: test_cases
-   :members:
-   :undoc-members:
-   :show-inheritance:
-
 Subpackages
 -----------
 
@@ -18,3 +10,10 @@ Subpackages
    test_cases.base_case
    test_cases.battery
 
+Module contents
+---------------
+
+.. automodule:: test_cases
+   :members:
+   :undoc-members:
+   :show-inheritance: