Update documentation

NREL · Dec 3, 2023 · 37fc812 · 37fc812
1 parent 1d7fc8c
commit 37fc812
Show file tree

Hide file tree

Showing 4 changed files with 73 additions and 52 deletions.
diff --git a/_sources/tutorials/1 - Basic run.ipynb b/_sources/tutorials/1 - Basic run.ipynb
@@ -28,8 +28,7 @@
     "%%bash\n",
     "wget https://github.com/LBNL-ETA/Radiance/releases/download/012cb178/Radiance_012cb178_Linux.zip -O radiance.zip\n",
     "unzip radiance.zip\n",
-    "tar -xvf radiance-5.3.012cb17835-Linux.tar.gz\n",
-    "#ls -l $PWD"
+    "tar -xvf radiance-5.3.012cb17835-Linux.tar.gz;"
    ]
   },
   {
@@ -47,8 +46,21 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "cp -r radiance-5.3.012cb17835-Linux/usr/local/radiance/bin/* /usr/local/bin\n",
-    "rm radiance*"
+    "#!cp -r radiance-5.3.012cb17835-Linux/usr/local/radiance/bin/* /usr/local/bin\n",
+    "#!cp -r radiance-5.3.012cb17835-Linux/usr/local/radiance/lib/* /usr/local/lib\n",
+    "#!rm -r radiance*"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": [
+    "import os\n",
+    "os.environ['PATH'] += \":radiance-5.3.012cb17835-Linux/usr/local/radiance/bin\"\n",
+    "os.environ['LIBRARYPATH'] += \":radiance-5.3.012cb17835-Linux/usr/local/radiance/lib\"\n",
+    "os.environ['RAYPATH'] = \":radiance-5.3.012cb17835-Linux/usr/local/radiance/lib\""
    ]
   },
   {
@@ -102,9 +114,10 @@
     "simulationname = 'tutorial_1'\n",
     "\n",
     "# Location:\n",
-    "lat = 39.7407 # ° N, \n",
+    "lat = 25..7407 # ° N, \n",
     "lon = -105.1686 # ° W\n",
     "\n",
+    "25.2854° N, 51.5310° E\n",
     "\n",
     "# Scene Parameters:\n",
     "azimuth_ang=90 # Facing south\n",
@@ -153,7 +166,7 @@
    "outputs": [],
    "source": [
     "#Valid options: mm_dd, mm_dd_HH, mm_dd_HHMM, YYYY-mm-dd_HHMM\n",
-    "metdata = demo.readWeatherFile(epwfile, coerce_year=2021, starttime='2021-06-01', endtime='2021-06-30')"
+    "metdata = demo.readWeatherFile(epwfile, coerce_year=2023, starttime='2023-12-04', endtime='2023-12-04')"
    ]
   },
   {
@@ -162,8 +175,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "demo.genCumSky()  \n",
-    "#demo.gendaylit(timeindex=0)  "
+    "demo.gendaylit(timeindex=7)  "
    ]
   },
   {
@@ -193,7 +205,7 @@
    "outputs": [],
    "source": [
     "analysis = br.AnalysisObj(octfile, demo.name)  \n",
-    "frontscan, backscan, groundscan = analysis.moduleAnalysis(scene, sensorsy=sensorsy, sensorsground=sensorsground)\n"
+    "frontscan, backscan = analysis.moduleAnalysis(scene, sensorsy=sensorsy)\n"
    ]
   },
   {
@@ -202,7 +214,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "analysis.analysis(octfile, simulationname+\"_groundscan_East\", groundscan, backscan)  # compare the back vs front irradiance  "
+    "analysis.analysis(octfile, simulationname+\"_modulescan\", frontscan, backscan)  # compare the back vs front irradiance  "
    ]
   }
  ],

diff --git a/reports/tutorials/1 - Basic run.err.log b/reports/tutorials/1 - Basic run.err.log
@@ -24,14 +24,13 @@ nbclient.exceptions.CellExecutionError: An error occurred while executing the fo
 %%bash
 wget https://github.com/LBNL-ETA/Radiance/releases/download/012cb178/Radiance_012cb178_Linux.zip -O radiance.zip
 unzip radiance.zip
-tar -xvf radiance-5.3.012cb17835-Linux.tar.gz
-#ls -l $PWD
+tar -xvf radiance-5.3.012cb17835-Linux.tar.gz;
 ------------------
 
 [1;31m---------------------------------------------------------------------------[0m
 [1;31mCalledProcessError[0m                        Traceback (most recent call last)
 Cell [1;32mIn[1], line 1[0m
-[1;32m----> 1[0m get_ipython()[38;5;241m.[39mrun_cell_magic([38;5;124m'[39m[38;5;124mbash[39m[38;5;124m'[39m, [38;5;124m'[39m[38;5;124m'[39m, [38;5;124m'[39m[38;5;124mwget https://github.com/LBNL-ETA/Radiance/releases/download/012cb178/Radiance_012cb178_Linux.zip -O radiance.zip[39m[38;5;130;01m\n[39;00m[38;5;124munzip radiance.zip[39m[38;5;130;01m\n[39;00m[38;5;124mtar -xvf radiance-5.3.012cb17835-Linux.tar.gz[39m[38;5;130;01m\n[39;00m[38;5;124m#ls -l $PWD[39m[38;5;130;01m\n[39;00m[38;5;124m'[39m)
+[1;32m----> 1[0m get_ipython()[38;5;241m.[39mrun_cell_magic([38;5;124m'[39m[38;5;124mbash[39m[38;5;124m'[39m, [38;5;124m'[39m[38;5;124m'[39m, [38;5;124m'[39m[38;5;124mwget https://github.com/LBNL-ETA/Radiance/releases/download/012cb178/Radiance_012cb178_Linux.zip -O radiance.zip[39m[38;5;130;01m\n[39;00m[38;5;124munzip radiance.zip[39m[38;5;130;01m\n[39;00m[38;5;124mtar -xvf radiance-5.3.012cb17835-Linux.tar.gz;[39m[38;5;130;01m\n[39;00m[38;5;124m'[39m)
 
 File [1;32mC:\ProgramData\anaconda3\Lib\site-packages\IPython\core\interactiveshell.py:2475[0m, in [0;36mInteractiveShell.run_cell_magic[1;34m(self, magic_name, line, cell)[0m
 [0;32m   2473[0m [38;5;28;01mwith[39;00m [38;5;28mself[39m[38;5;241m.[39mbuiltin_trap:
@@ -55,6 +54,6 @@ File [1;32mC:\ProgramData\anaconda3\Lib\site-packages\IPython\core\magics\scrip
 [0;32m    304[0m     rc [38;5;241m=[39m p[38;5;241m.[39mreturncode [38;5;129;01mor[39;00m [38;5;241m-[39m[38;5;241m9[39m
 [1;32m--> 305[0m     [38;5;28;01mraise[39;00m CalledProcessError(rc, cell)
 
-[1;31mCalledProcessError[0m: Command 'b'wget https://github.com/LBNL-ETA/Radiance/releases/download/012cb178/Radiance_012cb178_Linux.zip -O radiance.zip\nunzip radiance.zip\ntar -xvf radiance-5.3.012cb17835-Linux.tar.gz\n#ls -l $PWD\n'' returned non-zero exit status 1.
-CalledProcessError: Command 'b'wget https://github.com/LBNL-ETA/Radiance/releases/download/012cb178/Radiance_012cb178_Linux.zip -O radiance.zip\nunzip radiance.zip\ntar -xvf radiance-5.3.012cb17835-Linux.tar.gz\n#ls -l $PWD\n'' returned non-zero exit status 1.
+[1;31mCalledProcessError[0m: Command 'b'wget https://github.com/LBNL-ETA/Radiance/releases/download/012cb178/Radiance_012cb178_Linux.zip -O radiance.zip\nunzip radiance.zip\ntar -xvf radiance-5.3.012cb17835-Linux.tar.gz;\n'' returned non-zero exit status 1.
+CalledProcessError: Command 'b'wget https://github.com/LBNL-ETA/Radiance/releases/download/012cb178/Radiance_012cb178_Linux.zip -O radiance.zip\nunzip radiance.zip\ntar -xvf radiance-5.3.012cb17835-Linux.tar.gz;\n'' returned non-zero exit status 1.