diff --git a/docs/ref/epjson2rad.md b/docs/ref/epjson2rad.md new file mode 100644 index 0000000..e69de29 diff --git a/docs/ref/epmodel.md b/docs/ref/epmodel.md new file mode 100644 index 0000000..d853a77 --- /dev/null +++ b/docs/ref/epmodel.md @@ -0,0 +1,3 @@ +::: frads.EPModel + +::: frads.epjson2rad.epjson2rad diff --git a/docs/ref/epsetup.md b/docs/ref/epsetup.md new file mode 100644 index 0000000..8da459b --- /dev/null +++ b/docs/ref/epsetup.md @@ -0,0 +1 @@ +::: frads.EnergyPlusSetup diff --git a/docs/ref/fivephase.md b/docs/ref/fivephase.md new file mode 100644 index 0000000..d7bae33 --- /dev/null +++ b/docs/ref/fivephase.md @@ -0,0 +1 @@ +::: frads.FivePhaseMethod diff --git a/docs/ref/matrix.md b/docs/ref/matrix.md new file mode 100644 index 0000000..1b678e9 --- /dev/null +++ b/docs/ref/matrix.md @@ -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 diff --git a/docs/ref/sky.md b/docs/ref/sky.md new file mode 100644 index 0000000..91288e5 --- /dev/null +++ b/docs/ref/sky.md @@ -0,0 +1,3 @@ +::: frads.gen_perez_sky +::: frads.genskymtx + diff --git a/docs/ref/threephase.md b/docs/ref/threephase.md new file mode 100644 index 0000000..a1c5345 --- /dev/null +++ b/docs/ref/threephase.md @@ -0,0 +1 @@ +::: frads.ThreePhaseMethod diff --git a/docs/ref/twophase.md b/docs/ref/twophase.md new file mode 100644 index 0000000..d351eb3 --- /dev/null +++ b/docs/ref/twophase.md @@ -0,0 +1 @@ +::: frads.TwoPhaseMethod diff --git a/docs/ref/window.md b/docs/ref/window.md new file mode 100644 index 0000000..7562796 --- /dev/null +++ b/docs/ref/window.md @@ -0,0 +1,3 @@ + +::: frads.GlazingSystem + diff --git a/docs/why.md b/docs/why.md new file mode 100644 index 0000000..a7bc66d --- /dev/null +++ b/docs/why.md @@ -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.