Skip to content

Commit

Permalink
docs: add doc files
Browse files Browse the repository at this point in the history
  • Loading branch information
Taoning Wang committed Aug 31, 2023
1 parent 89a6e60 commit 0e1be7f
Show file tree
Hide file tree
Showing 10 changed files with 63 additions and 0 deletions.
Empty file added docs/ref/epjson2rad.md
Empty file.
3 changes: 3 additions & 0 deletions docs/ref/epmodel.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
::: frads.EPModel

::: frads.epjson2rad.epjson2rad
1 change: 1 addition & 0 deletions docs/ref/epsetup.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: frads.EnergyPlusSetup
1 change: 1 addition & 0 deletions docs/ref/fivephase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: frads.FivePhaseMethod
27 changes: 27 additions & 0 deletions docs/ref/matrix.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
Frads Matrix class simply encapsulate the components
necessary to generate a matrix, such as ray sender and
receiver. The matrix data is by default store as numpy
array in memory for later access.


::: frads.Matrix

::: frads.SensorSender

::: frads.ViewSender

::: frads.SurfaceSender

::: frads.SkyReceiver

::: frads.SurfaceReceiver

::: frads.SunMatrix

::: frads.SunReceiver

::: frads.load_matrix

::: frads.load_binary_matrix

::: frads.surfaces_view_factor
3 changes: 3 additions & 0 deletions docs/ref/sky.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@
::: frads.gen_perez_sky
::: frads.genskymtx

1 change: 1 addition & 0 deletions docs/ref/threephase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: frads.ThreePhaseMethod
1 change: 1 addition & 0 deletions docs/ref/twophase.md
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
::: frads.TwoPhaseMethod
3 changes: 3 additions & 0 deletions docs/ref/window.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,3 @@

::: frads.GlazingSystem

23 changes: 23 additions & 0 deletions docs/why.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
# Why use frads

Matrix algebraic methods reduce the time needed to perform accurate,
ray-tracing based, annual daylight simulations by several orders of
magnitude. A good deal of expertise is needed to set up the simulations
properly to achieve the desired level of accuracy.
frads provides users with tools (e.g., `mrad`) that automatically
determine which matrix-based method to use then sets the associated
simulation parameters, helping beginners learn the different matrix
methods by observing the tools’ behavior. The user is still required
to understand basic concepts underlying matrix-based simulation methods
(see [tutorials](https://www.radiance-online.org/learning/tutorials)).

Matrix-based methods also enable accurate, ray-tracing generated,
irradiance, illuminance, and luminance data to be available for
run-time data exchange and co-simulations. frads provides users with
tools that generate the appropriate Radiance-generated
data then interfaces with the “actuator” EMS module in EnergyPlus or
within the Spawn-of-EnergyPlus and Modelica co-simulation environment.
This enables end users to evaluate the performance of buildings with
manual- and automatically-controlled shading and daylighting systems
or other site and building features that can change parametrically
or on a time-step basis.

0 comments on commit 0e1be7f

Please sign in to comment.