update docs

LBNL-ETA · Aug 11, 2023 · 7d36743 · 7d36743
1 parent da934ba
commit 7d36743
Show file tree

Hide file tree

Showing 4 changed files with 25 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -44,6 +44,12 @@ You can verify that Python is installed by typing python from your cmd/powershel
 	Type "help", "copyright", "credits" or "license" for more information.
 	>>>
 
+### Installing pyenergyplus
+frads relies on pyenergyplus for running and interacting with EnergyPlus in Python.
+pyenergyplus can be installed by downloading and installing [wheels](https://github.com/taoning/pyenergyplus/releases/tag/v23.1.0)
+for your specific platform.
+
+
 ### Install frads
 
 After you have Python installed, you should have `pip` command available in your shell environment as well. You can then use `pip` to install `frads`:

diff --git a/docs/manual/index.md b/docs/manual/index.md
@@ -2,4 +2,3 @@ Frads CLI manual
 
 * [mrad](mrad/index.md)
 * [gen](gen/index.md)
-* [gencolorsky](gencolorsky.md)
diff --git a/docs/ref/index.md b/docs/ref/index.md
@@ -3,34 +3,30 @@ This reference guide contains a detailed description of the `frads` API.
 It describes how the functions and methods work and which parameter can be used.
 It assumes that you have an understanding of the key concepts.
 
-1. [Color](#frads.color)
-1. [Parsers](#frads.parsers)
-3. [Sky](#frads.sky)
-4. [Data types and containers](#frads.types)
-2. [Geometry](#frads.geom)
-2. [Utility](#frads.utils)
-5. [Matrix](#frads.matrix)
+1. [Methods](#frads.methods)
+2. [Matrix](#frads.matrix)
+3. [EnergyPlusModel](#frads.eprad)
+4. [EnergyPlus To Radiance](#frads.epjson2rad)
+5. [Window](#frads.window)
+3. [Utility](#frads.utils)
+4. [Geometry](#frads.geom)
+5. [Sky](#frads.sky)
+
+::: frads.methods.TwoPhaseMethod
+::: frads.methods.ThreePhaseMethod
+::: frads.methods.FivePhaseMethod
 
-::: frads.color
+::: frads.matrix
 
-::: frads.parsers
+::: frads.eprad
 
-::: frads.sky
+::: frads.epjson2rad
 
-::: frads.types
-    options:
-      members:
-        - Primitive
-        - Sender
-        - Receiver
-        - PaneProperty
-        - WeaMetaData
-        - WeaData
-        - MradModel
-        - MradPath
+::: frads.window
+
+::: frads.utils
 
 ::: frads.geom
 
-::: frads.utils
+::: frads.sky
 
-::: frads.matrix
diff --git a/mkdocs.yml b/mkdocs.yml
@@ -79,7 +79,6 @@ nav:
         - view-sun: manual/gen/matrix/view_sun.md
         - ncp: manual/gen/matrix/ncp.md
       - room: manual/gen/room.md
-    - gencolorsky: manual/gencolorsky.md
   - How-To Guides:
     - how-to/index.md
   - Reference: