Add docs inputs and outputs sections.

NREL · Oct 10, 2024 · 3c9d721 · 3c9d721
1 parent e9fa951
commit 3c9d721
Show file tree

Hide file tree

Showing 2 changed files with 70 additions and 0 deletions.
diff --git a/docs/source/workflow_inputs.rst b/docs/source/workflow_inputs.rst
@@ -4544,6 +4544,44 @@ In addition, the PVSystem must be connected to an inverter that is entered as a
 
   .. [#] For homes with multiple inverters, all InverterEfficiency elements must have the same value.
 
+.. _hpxml_electric_panels:
+
+HPXML Electric Panels
+*********************
+
+A single electric panel can be entered as a ``/HPXML/Building/BuildingDetails/Systems/ElectricPanels/ElectricPanel``.
+
+  ====================================================  =======  =========  =======================  ========  ========  ============================================
+  Element                                               Type     Units      Constraints              Required  Default   Notes
+  ====================================================  =======  =========  =======================  ========  ========  ============================================
+  ``SystemIdentifier``                                  id                                           Yes                 Unique identifier
+  ``Voltage``                                           string              See [#]_                 No        240?
+  ``MaxCurrentRating``                                  double                                       No        ?
+  ``PanelLoads``                                        element                                      No        <none>    Individual electric panel loads [#]_
+  ====================================================  =======  =========  =======================  ========  ========  ============================================
+
+  .. [#] Voltage choices are "120" or "240".
+  .. [#] If PanelLoads is provided, see :ref:`panel_loads`.
+
+.. _panel_loads:
+
+Panel Loads
+~~~~~~~~~~~
+
+TODO entered in ``extension/PanelLoads/PanelLoad``.
+
+  ==============================================  ========  ==============  ===========  ========  =========  ==========================================
+  Element                                         Type      Units           Constraints  Required  Default    Notes
+  ==============================================  ========  ==============  ===========  ========  =========  ==========================================
+  ``Type``                                        string                    See [#]_     Yes
+  ``Watts``                                       double    W                            Yes
+  ``Voltage``                                     string    V               See [#]_     No        120?
+  ``Addition``                                    boolean                                No        false
+  ==============================================  ========  ==============  ===========  ========  =========  ==========================================
+
+  .. [#] Type choices are "Heating", "Cooling", "Hot Water", or "Clothes Dryer".
+  .. [#] Voltage choices are "120" or "240".
+
 .. _hpxml_batteries:
 
 HPXML Batteries

diff --git a/docs/source/workflow_outputs.rst b/docs/source/workflow_outputs.rst
@@ -424,6 +424,38 @@ Resilience outputs are listed below.
          The entire electric load is treated as a "critical load" that would be supported during an outage.
          Resilience hours are set to 0 for any timestep where the battery is not charged, even if there is sufficient PV to power the building.
 
+Panel Capacities
+~~~~~~~~~~~~~~~~
+
+Panel outputs are listed below.
+
+  ====================================================  ====================
+  Type                                                  Notes
+  ====================================================  ====================
+  Electric Panel: Load: Heating (W)
+  Electric Panel: Load: Cooling (W)
+  Electric Panel: Load: Hot Water (W)
+  Electric Panel: Load: Clothes Dryer (W)
+  Electric Panel: Load: Dishwasher (W)
+  Electric Panel: Load: Range/Oven (W)
+  Electric Panel: Load: Permanent Spa Heater (W)
+  Electric Panel: Load: Permanent Spa Pump (W)
+  Electric Panel: Load: Pool Heater (W)
+  Electric Panel: Load: Pool Pump (W)
+  Electric Panel: Load: Well Pump (W)
+  Electric Panel: Load: Electric Vehicle Charging (W)
+  Electric Panel: Load: Lighting (W)
+  Electric Panel: Load: Other (W)
+  Electric Panel: Capacity: Load-Based (W)              220.83
+  Electric Panel: Capacity: Load-Based (A)              220.83
+  Electric Panel: Constraint: Load-Based (A)            220.83
+  Electric Panel: Capacity: Meter-Based (W)             220.87
+  Electric Panel: Capacity: Meter-Based (A)             220.87
+  Electric Panel: Constraint: Meter-Based (A)           220.87
+  Electric Panel: Breaker Space: HVAC (#)
+  Electric Panel: Breaker Space: Whole Panel (#)
+  ====================================================  ====================
+
 HVAC Capacities
 ~~~~~~~~~~~~~~~