update docs

LBNL-ETA · Oct 30, 2023 · a6c654d · a6c654d
1 parent ec51e43
commit a6c654d
Show file tree

Hide file tree

Showing 13 changed files with 171 additions and 103 deletions.
diff --git a/docs/how-to/guide5.md b/docs/how-to/guide5.md
@@ -1,7 +1,7 @@
 # How to model dynamic shading control and daylight dimming with EnergyPlus?
 
 
-The example demonstrates how to use a controller function to control the shading state, cooling setpoint temperature, and electric lighting power intensity during simulation. At the beginning of each timestep, EnergyPlus will call the controller function that operates the facade shading state based on exterior solar irradiance, cooling setpoint temperature based on time of day (pre-cooling), and electric lighting power intensity based on occupancy and workplane illuminance (daylight dimming). The workplane illuminance is calculated using the three-phase method through Radiance. 
+The example demonstrates how to use a controller function to control the shading state, cooling setpoint temperature, and electric lighting power intensity during simulation. At the beginning of each timestep, EnergyPlus will call the controller function that operates the facade shading state based on exterior solar irradiance, cooling setpoint temperature based on time of day (pre-cooling), and electric lighting power intensity based on occupancy and workplane illuminance (daylight dimming). The workplane illuminance is calculated using the three-phase method through Radiance.
 
 **Workflow**
 
@@ -27,7 +27,7 @@ graph LR
     R[Workplane Illuminance]
     end
     subgraph <b>EnergyPlus</b>
-    E[EnergyPlusModel]<--> K[Step 2.2 & 2.3 controller function<br/> <br/> * switch shading state <br/> * daylight dimming <br/>* pre-cooling <br/>] 
+    E[EnergyPlusModel]<--> K[Step 2.2 & 2.3 controller function<br/> <br/> * switch shading state <br/> * daylight dimming <br/>* pre-cooling <br/>]
     E <--> R
     K <--> R;
     end
@@ -68,7 +68,7 @@ Initialize an EnergyPlus model by calling `load_energyplus_model` and passing in
 epmodel = fr.load_energyplus_model(ref_models["medium_office"])
 ```
 
-or 
+or
 
 ```python
 epmodel = fr.load_energyplus_model("medium_office.idf")
@@ -78,7 +78,7 @@ epmodel = fr.load_energyplus_model("medium_office.idf")
 
 !!! example "Create four glazing systems for the four electrochromic tinted states"
     Each glazing system consists of:
-    
+
     * One layer of electrochromic glass
     * One gap (10% air and 90% argon) at 0.0127 m thickness
     * One layer of clear glass
@@ -135,7 +135,7 @@ gs_ec01 = fr.create_glazing_system(
     gs_ec60 = fr.create_glazing_system(
         name="ec60",
         layers=[
-            Patha("products/igsdb_product_7406.json"),
+            Path("products/igsdb_product_7406.json"),
             Path("products/CLEAR_3.DAT"),
         ],
         gaps=[
@@ -187,22 +187,22 @@ eps = fr.EnergyPlusSetup(
 
 ### 2.2 Define control algorithms using a controller function
 
-The controller function will control the facade shading state, cooling setpoint temperature, and electric lighting power intensity in the EnergyPlus model during simulation. 
+The controller function will control the facade shading state, cooling setpoint temperature, and electric lighting power intensity in the EnergyPlus model during simulation.
 
 !!! example "Controller function"
-    The example shows how to implement control algorithms for zone "Perimeter_bot_ZN_1", which has window "Perimeter_bot_ZN_1_Wall_South_Window" and lighting "Perimeter_bot_ZN_1_Lights". 
-    
+    The example shows how to implement control algorithms for zone "Perimeter_bot_ZN_1", which has window "Perimeter_bot_ZN_1_Wall_South_Window" and lighting "Perimeter_bot_ZN_1_Lights".
+
     * **Facade CFS state** based on exterior solar irradiance
     * **Cooling setpoint temperature** based on time of day (pre-cooling)
     * **Electric lighting power intensity** based on occupancy and workplane illuminance (daylight dimming)
 
 !!! notes "Actuate"
-    * **Gerneric actuator**
+    * **Generic actuator**
 
     Use `EnergyPlusSetup.actuate` to set or update the operating value of an actuator in the EnergyPlus model. `EnergyPlusSetup.actuate` takes in a component type, name, key, and value. The component type is the actuator category, e.g. "Weather Data". The name is the name of the actuator, e.g. "Outdoor Dew Point". The key is the instance of the variable to retrieve, e.g. "Environment". The value is the value to set the actuator to.
 
     * **Special actuator**
-    
+
         * **Facade CFS state**
 
         `EnergyPlusSetup.actuate_cfs_state` takes in a window name and a CFS state (the name of the glazing system).
@@ -254,7 +254,7 @@ def controller(state):
         cfs_state=cfs_state,
     )
 
-    # control cooling setpoint temperature based on the time of day 
+    # control cooling setpoint temperature based on the time of day
     # pre-cooling
     # get the current time
     datetime = ep.get_datetime()
@@ -328,4 +328,4 @@ To simulate, use `run` with optional parameters:
 
 ```python
 eps.run()
-```
+```
diff --git a/docs/ref/epjson2rad.md b/docs/ref/epjson2rad.md
diff --git a/docs/ref/eplus.md b/docs/ref/eplus.md
@@ -0,0 +1,4 @@
+::: frads.EnergyPlusSetup
+::: frads.EnergyPlusModel
+::: frads.epmodel_to_radmodel
+::: frads.load_energyplus_model
diff --git a/docs/ref/epmodel.md b/docs/ref/epmodel.md
diff --git a/docs/ref/epsetup.md b/docs/ref/epsetup.md
diff --git a/docs/ref/window.md b/docs/ref/window.md
@@ -1,3 +1,6 @@
 
 ::: frads.GlazingSystem
+::: frads.create_glazing_system
+::: frads.Gap
+::: frads.Gas
 
diff --git a/frads/__init__.py b/frads/__init__.py
@@ -54,6 +54,8 @@
 
 from .eplus import load_energyplus_model, EnergyPlusSetup, ep_datetime_parser
 
+from .eplus_model import EnergyPlusModel
+
 from .matrix import (
     load_matrix,
     load_binary_matrix,
@@ -101,12 +103,11 @@
 __all__ = [
     "AIR",
     "ARGON",
-    "create_glazing_system",
-    "Gap",
-    "Gas",
-    "load_energyplus_model",
+    "EnergyPlusModel",
     "EnergyPlusSetup",
     "FivePhaseMethod",
+    "Gap",
+    "Gas",
     "GlazingSystem",
     "KRYPTON",
     "Matrix",
@@ -123,12 +124,14 @@
     "WeaMetaData",
     "WorkflowConfig",
     "XENON",
+    "create_glazing_system",
     "ep_datetime_parser",
     "epmodel_to_radmodel",
     "gen_grid",
     "gen_perez_sky",
     "genskymtx",
     "load_binary_matrix",
+    "load_energyplus_model",
     "load_matrix",
     "matrix_multiply_rgb",
     "parse_epw",

diff --git a/frads/ep2rad.py b/frads/ep2rad.py
@@ -593,14 +593,20 @@ def create_settings(ep_model: EnergyPlusModel, epw_file: Optional[str]) -> dict:
 def epmodel_to_radmodel(
     ep_model: EnergyPlusModel, epw_file: Optional[str] = None, add_views: bool = True
 ) -> dict:
-    """Convert EnergyPlus model to Radiance model.
+    """Convert EnergyPlus model to Radiance models where each zone is a separate model.
 
     Args:
         ep_model: EnergyPlus model.
         epw_file: EnergyPlus weather file path. Defaults to None.
+        add_views: Add views to the model. Such views will be positioned
+            at the center of the zone facing windows weighted by window
+            area. Defaults to True.
 
     Returns:
-        dict: Radiance model.
+        dict: Radiance models.
+
+    Examples:
+        >>> radmodels = epmodel_to_radmodel(ep_model, epw_file)
     """
     model_parser = EnergyPlusToRadianceModelConverter(ep_model)
     zone_models = model_parser.parse()