From a046a621d8ff6ea2f1a464c2bf9192446690a549 Mon Sep 17 00:00:00 2001 From: Tammie Yu Date: Mon, 11 Mar 2024 13:11:42 -0700 Subject: [PATCH] docs(guide_rad7):gen room --- docs/how-to/guide_rad1.md | 12 +++++++----- docs/how-to/guide_rad7.md | 13 +++++++------ 2 files changed, 14 insertions(+), 11 deletions(-) diff --git a/docs/how-to/guide_rad1.md b/docs/how-to/guide_rad1.md index affea25..e5df3bd 100644 --- a/docs/how-to/guide_rad1.md +++ b/docs/how-to/guide_rad1.md @@ -9,7 +9,7 @@ model and the workflow of computing irradiance values. If you already have a Radiance model setup, you can skip this step and follow along using your own. -If you don't have a model already we can use `genradroom` to get ourself +If you don't have a model already we can use `gen room` to get ourself a simple Radiance model. Let's generate a open-office sized side-lit room @@ -17,17 +17,19 @@ with four same-sized windows. The room will be 12 meters wide, 14 meters deep, a floor to floor height of 4 meters, and a ceiling height of 3 meters. Each window is 2.5 meters in width and 1.8 meters in height and has a sill height of 1 meter. Windows are 0.4 meters apart from each other. Finally, we want our facade to have a thickness -of 0.1 meters. We'll call this model 'aroom'. The `genradroom` command is: +of 0.1 meters. We'll call this model 'aroom'. The `gen room` command is: -``` -$ gen room 12 14 4 3 \ +```python +! gen room 12 14 4 3 \ -w 0.4 1 2.5 1.8 \ -w 3.3 1 2.5 1.8 \ -w 6.2 1 2.5 1.8 \ -w 9.1 1 2.5 1.8 \ - -t 0.1 -n aroom + -t 0.1 -n aroom # (1) ``` +1. `gen room` is a command line function. To run shell commands from inside a IPython syntax (e.g. Jupyter Notebook), start the code with an exclamation mark (!). + Afterwards, we will have a `Objects` folder in our current working directory with all of our Radiance model inside. diff --git a/docs/how-to/guide_rad7.md b/docs/how-to/guide_rad7.md index 2138fe3..c8b7be1 100644 --- a/docs/how-to/guide_rad7.md +++ b/docs/how-to/guide_rad7.md @@ -24,19 +24,20 @@ import numpy as np If you already have a Radiance model setup, please have a octree file storing the scene files and continue on to the next step. If not, follow below to set up a sample Radiance model. See [How to setup a simple rtrace workflow?](guide_rad1.md) for more details. -Use `gen room` in a command line interface to generate -a simple Radiance model. The example 'aroom' is a open-office sized side-lit room with four same-sized windows. The room will be 12 meters wide, 14 meters deep, a floor to floor height of 4 meters, and a ceiling height of 3 meters. Each window is 2.5 meters in width and 1.8 meters in height and has a sill height of 1 meter. Windows are 0.4 meters apart from each other. Finally, the facade has a thickness of 0.1 meters. +Use `gen room` (a command line function) to generate a simple Radiance model. The example 'aroom' is a open-office sized side-lit room with four same-sized windows. The room will be 12 meters wide, 14 meters deep, a floor to floor height of 4 meters, and a ceiling height of 3 meters. Each window is 2.5 meters in width and 1.8 meters in height and has a sill height of 1 meter. Windows are 0.4 meters apart from each other. Finally, the facade has a thickness of 0.1 meters. -``` -$ gen room 12 14 4 3 \ +```python +! gen room 12 14 4 3 \ -w 0.4 1 2.5 1.8 \ -w 3.3 1 2.5 1.8 \ -w 6.2 1 2.5 1.8 \ -w 9.1 1 2.5 1.8 \ - -t 0.1 -n aroom + -t 0.1 -n aroom # (1) ``` -In a Python environment, call `pyradiance.oconv` to generate a `octree` file storing the material and geometry files generated from the `gen room` command in the 'Objects' directory +1. `gen room` is a command line function. To run shell commands from inside a IPython syntax (e.g. Jupyter Notebook), start the code with an exclamation mark (!). + +Call `pyradiance.oconv` to generate a `octree` file storing the material and geometry files generated from the `gen room` command in the 'Objects' directory ```python fpaths = ["Objects/materials_aroom.mat",