update titles journals internally

NREL · Mar 10, 2023 · 6673808 · 6673808
1 parent a2e109a
commit 6673808
Show file tree

Hide file tree

Showing 38 changed files with 224 additions and 51 deletions.
diff --git a/docs/tutorials/1 - Fixed Tilt Yearly Results.ipynb b/docs/tutorials/1 - Fixed Tilt Yearly Results.ipynb
@@ -4,7 +4,26 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 1 - Introductory Example: Fixed-Tilt simple setup\n",
+    "# 1 - Fixed-Tilt Yearly Results\n",
+    "\n",
+    "This jupyter journal will walk us through the creation of the most basic fixed-tilt simulation possible with bifacial_radiance.\n",
+    "We will simulate a 1-up landscape system over a white rooftop.\n",
+    "\n",
+    "Steps include:\n",
+    "\n",
+    "<ol>\n",
+    "    <li> <a href='#step1'> Create a folder for your simulation, and Load bifacial_radiance </a></li> \n",
+    "    <li> <a href='#step2'> Create a Radiance Object </a></li> \n",
+    "    <li> <a href='#step3'> Set the Albedo </a></li> \n",
+    "    <li> <a href='#step4'> Download Weather Files </a></li> \n",
+    "    <li> <a href='#step5'> Generate the Sky </a></li> \n",
+    "    <li> <a href='#step6'> Define a Module type </a></li> \n",
+    "    <li> <a href='#step7'> Create the scene </a></li> \n",
+    "    <li> <a href='#step8'> Combine Ground, Sky and Scene Objects </a></li> \n",
+    "    <li> <a href='#step9'> Analyze and get results </a></li> \n",
+    "    <li> <a href='#step10'> Visualize scene options </a></li>   \n",
+    "</ol>\n",
+    "\n",
     "\n",
     "This jupyter journal will walk us through the creation of the most basic fixed-tilt simulation possible with bifacial_radiance.\n",
     "We will simulate a 1-up landscape system over a white rooftop.\n",

diff --git a/docs/tutorials/1 - Fixed Tilt Yearly Results.py b/docs/tutorials/1 - Fixed Tilt Yearly Results.py
@@ -1,7 +1,26 @@
 #!/usr/bin/env python
 # coding: utf-8
 
-# # 1 - Introductory Example: Fixed-Tilt simple setup
+# # 1 - Fixed-Tilt Yearly Results
+# 
+# This jupyter journal will walk us through the creation of the most basic fixed-tilt simulation possible with bifacial_radiance.
+# We will simulate a 1-up landscape system over a white rooftop.
+# 
+# Steps include:
+# 
+# <ol>
+#     <li> <a href='#step1'> Create a folder for your simulation, and Load bifacial_radiance </a></li> 
+#     <li> <a href='#step2'> Create a Radiance Object </a></li> 
+#     <li> <a href='#step3'> Set the Albedo </a></li> 
+#     <li> <a href='#step4'> Download Weather Files </a></li> 
+#     <li> <a href='#step5'> Generate the Sky </a></li> 
+#     <li> <a href='#step6'> Define a Module type </a></li> 
+#     <li> <a href='#step7'> Create the scene </a></li> 
+#     <li> <a href='#step8'> Combine Ground, Sky and Scene Objects </a></li> 
+#     <li> <a href='#step9'> Analyze and get results </a></li> 
+#     <li> <a href='#step10'> Visualize scene options </a></li>   
+# </ol>
+# 
 # 
 # This jupyter journal will walk us through the creation of the most basic fixed-tilt simulation possible with bifacial_radiance.
 # We will simulate a 1-up landscape system over a white rooftop.

diff --git a/docs/tutorials/11 - AgriPV Systems.ipynb b/docs/tutorials/11 - AgriPV Systems.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 11 - Advanced Level Example - Modeling an Agriculture+PV (AGRIPV) Site \n",
+    "# 11 - AgriPV Systems\n",
     "\n",
     "This journal shows how to model an AgriPV site, calculating the irradiance not only on the modules but also the irradiance received by the ground to evaluate available solar ersource for plants. \n",
     "\n",

diff --git a/docs/tutorials/11 - AgriPV Systems.py b/docs/tutorials/11 - AgriPV Systems.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # coding: utf-8
 
-# # 11 - Advanced Level Example - Modeling an Agriculture+PV (AGRIPV) Site 
+# # 11 - AgriPV Systems
 # 
 # This journal shows how to model an AgriPV site, calculating the irradiance not only on the modules but also the irradiance received by the ground to evaluate available solar ersource for plants. 
 # 

diff --git a/docs/tutorials/12 - AgriPV Clearance Height Evaluation.ipynb b/docs/tutorials/12 - AgriPV Clearance Height Evaluation.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 12 - Advanced topics - AgriPV Clearance Height Evaluation\n",
+    "# 12 - AgriPV Clearance Height Evaluation\n",
     "\n",
     "This journal is based on Journal 11, now looping through various clearance-heights of the modules to evaluate ground irradiance and bifacial gain.\n",
     "\n",

diff --git a/docs/tutorials/12 - AgriPV Clearance Height Evaluation.py b/docs/tutorials/12 - AgriPV Clearance Height Evaluation.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # coding: utf-8
 
-# # 12 - Advanced topics - AgriPV Clearance Height Evaluation
+# # 12 - AgriPV Clearance Height Evaluation
 # 
 # This journal is based on Journal 11, now looping through various clearance-heights of the modules to evaluate ground irradiance and bifacial gain.
 # 

diff --git a/docs/tutorials/13 - Modeling Modules with Glass.ipynb b/docs/tutorials/13 - Modeling Modules with Glass.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 13 - Medium Level Example - Modeling Modules with Glass\n",
+    "# 13 - Modeling Modules with Glass\n",
     "\n",
     "\n",
     "This journal shows how to add glass to the modules. It also shows how to sample irradiance on the surface of the glass, as well as on the surface of the module. Surface of the module is slightlyt less irradiance due to fresnel losses (a.k.a. Angle of Incidence losses (AOI))\n",

diff --git a/docs/tutorials/13 - Modeling Modules with Glass.py b/docs/tutorials/13 - Modeling Modules with Glass.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # coding: utf-8
 
-# # 13 - Medium Level Example - Modeling Modules with Glass
+# # 13 - Modeling Modules with Glass
 # 
 # 
 # This journal shows how to add glass to the modules. It also shows how to sample irradiance on the surface of the glass, as well as on the surface of the module. Surface of the module is slightlyt less irradiance due to fresnel losses (a.k.a. Angle of Incidence losses (AOI))

diff --git a/docs/tutorials/14 - Cement Racking Albedo Improvements.ipynb b/docs/tutorials/14 - Cement Racking Albedo Improvements.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 14 - Advanced topics - Cement Pavers albedo example\n",
+    "# 14 - Cement Racking Albedo Improvements\n",
     "\n",
     "This journal creates a paver underneath the single-axis trackers, and evaluates the improvement for one day -- June 17th with and without the pavers for a location in Davis, CA.\n",
     "\n",

diff --git a/docs/tutorials/14 - Cement Racking Albedo Improvements.py b/docs/tutorials/14 - Cement Racking Albedo Improvements.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # coding: utf-8
 
-# # 14 - Advanced topics - Cement Pavers albedo example
+# # 14 - Cement Racking Albedo Improvements
 # 
 # This journal creates a paver underneath the single-axis trackers, and evaluates the improvement for one day -- June 17th with and without the pavers for a location in Davis, CA.
 # 

diff --git a/docs/tutorials/15 - New Functionalities Examples.ipynb b/docs/tutorials/15 - New Functionalities Examples.ipynb
@@ -5,7 +5,7 @@
    "id": "d44f4591",
    "metadata": {},
    "source": [
-    "# 15 - NEW FUNCTIONALITIES EXAMPLES\n",
+    "# 15 - New Functionalities Examples\n",
     "\n",
     "This journal includes short examples on how to use the new functionalities of version 0.4.0 of bifacial_radiance. The parts are:\n",
     "\n",
@@ -540,7 +540,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -554,7 +554,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.8"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/docs/tutorials/15 - New Functionalities Examples.py b/docs/tutorials/15 - New Functionalities Examples.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # coding: utf-8
 
-# # 15 - NEW FUNCTIONALITIES EXAMPLES
+# # 15 - New Functionalities Examples
 # 
 # This journal includes short examples on how to use the new functionalities of version 0.4.0 of bifacial_radiance. The parts are:
 # 

diff --git a/docs/tutorials/18 - AgriPV - Coffee Plantation with Tree Modeling.ipynb b/docs/tutorials/18 - AgriPV - Coffee Plantation with Tree Modeling.ipynb
@@ -5,7 +5,8 @@
    "id": "4997ec7a",
    "metadata": {},
    "source": [
-    "# 18 - AgriPV: Designing for adecuate crop shading "
+    "# 18 - AgriPV - Coffee Plantation with Tree Modeling\n",
+    "## Designing for adecuate crop shading "
    ]
   },
   {
@@ -916,7 +917,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "Python 3",
+   "display_name": "Python 3 (ipykernel)",
    "language": "python",
    "name": "python3"
   },
@@ -930,7 +931,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.8"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,

diff --git a/docs/tutorials/18 - AgriPV - Coffee Plantation with Tree Modeling.py b/docs/tutorials/18 - AgriPV - Coffee Plantation with Tree Modeling.py
@@ -1,7 +1,8 @@
 #!/usr/bin/env python
 # coding: utf-8
 
-# # 18 - AgriPV: Designing for adecuate crop shading 
+# # 18 - AgriPV - Coffee Plantation with Tree Modeling
+# ## Designing for adecuate crop shading 
 
 # This journal supports the process of designing a solar panel configuration to appropriately represent ideal shading conditions for coffee production underneath elevated solar panels. 
 # 

diff --git a/docs/tutorials/19 - East & West Facing Sheds.ipynb b/docs/tutorials/19 - East & West Facing Sheds.ipynb
@@ -5,7 +5,7 @@
    "id": "2960c9a2",
    "metadata": {},
    "source": [
-    "# 19 - Example Simluation: East West Sheds\n",
+    "# 19 - East & West Facing Sheds\n",
     "\n",
     "This simulates a particular case where you have alternating rows facing east and west, in \"E-W sheds\". \n",
     "\n",

diff --git a/docs/tutorials/19 - East & West Facing Sheds.py b/docs/tutorials/19 - East & West Facing Sheds.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # coding: utf-8
 
-# # 19 - Example Simluation: East West Sheds
+# # 19 - East & West Facing Sheds
 # 
 # This simulates a particular case where you have alternating rows facing east and west, in "E-W sheds". 
 # 

diff --git a/docs/tutorials/2 - Single Axis Tracking Yearly Simulation.ipynb b/docs/tutorials/2 - Single Axis Tracking Yearly Simulation.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 2 - Introductory Example - 1-Axis tracker with cumulative sky\n",
+    "# 2 - Single Axis Tracking Yearly Simulation\n",
     "\n",
     "Method <b> Gencumsky </b> has been modified to divide the yearly-cumulative sky into various skies, each one representing the cumulative irradiance for the hours at which the tracker is at a certain angle. For faster running, for a tracker that moves between 45 and -45 degrees limit angle, if only positions every 5 degrees are considered (45, 40, 35 .... -4-, -45), then only 18 skies (and 18 simulations) will be run for the whole year.\n",
     "\n",

diff --git a/docs/tutorials/2 - Single Axis Tracking Yearly Simulation.py b/docs/tutorials/2 - Single Axis Tracking Yearly Simulation.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # coding: utf-8
 
-# # 2 - Introductory Example - 1-Axis tracker with cumulative sky
+# # 2 - Single Axis Tracking Yearly Simulation
 # 
 # Method <b> Gencumsky </b> has been modified to divide the yearly-cumulative sky into various skies, each one representing the cumulative irradiance for the hours at which the tracker is at a certain angle. For faster running, for a tracker that moves between 45 and -45 degrees limit angle, if only positions every 5 degrees are considered (45, 40, 35 .... -4-, -45), then only 18 skies (and 18 simulations) will be run for the whole year.
 # 

diff --git a/docs/tutorials/20 - Racking I Beams.ipynb b/docs/tutorials/20 - Racking I Beams.ipynb
@@ -5,7 +5,7 @@
    "id": "407ac0a2",
    "metadata": {},
    "source": [
-    "# 20 - Example Simulation - I Beams\n",
+    "# 20 - Racking I Beams\n",
     "\n",
     "This Journal shows how to model a site including I beams. While the I Beams can be added to the module unit, doing it for the whole row reduces the amount of geometries in the scene and makes raytracing faster.\n",
     "\n",

diff --git a/docs/tutorials/20 - Racking I Beams.py b/docs/tutorials/20 - Racking I Beams.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # coding: utf-8
 
-# # 20 - Example Simulation - I Beams
+# # 20 - Racking I Beams
 # 
 # This Journal shows how to model a site including I beams. While the I Beams can be added to the module unit, doing it for the whole row reduces the amount of geometries in the scene and makes raytracing faster.
 # 

diff --git a/docs/tutorials/21 - Weather to Module Performance.ipynb b/docs/tutorials/21 - Weather to Module Performance.ipynb
@@ -5,7 +5,8 @@
    "id": "a54352a3",
    "metadata": {},
    "source": [
-    "# 21 - Example Simulation - Modeling Performance, an End to End Simulation\n",
+    "# 21 - Weather to Module Performance\n",
+    "## Modeling Performance, an End to End Simulation\n",
     "\n",
     "This tutorial shows how to use the new function on bifacial_radiance calculatePerformanceModule performance, as well as how to find CEC Module parameters.\n"
    ]

diff --git a/docs/tutorials/21 - Weather to Module Performance.py b/docs/tutorials/21 - Weather to Module Performance.py
@@ -1,7 +1,8 @@
 #!/usr/bin/env python
 # coding: utf-8
 
-# # 21 - Example Simulation - Modeling Performance, an End to End Simulation
+# # 21 - Weather to Module Performance
+# ## Modeling Performance, an End to End Simulation
 # 
 # This tutorial shows how to use the new function on bifacial_radiance calculatePerformanceModule performance, as well as how to find CEC Module parameters.
 # 

diff --git a/docs/tutorials/22 - Mirrors and Modules.ipynb b/docs/tutorials/22 - Mirrors and Modules.ipynb
@@ -4,14 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "<a id='step1'></a>"
-   ]
-  },
-  {
-   "cell_type": "markdown",
-   "metadata": {},
-   "source": [
-    "# 22 - Example Simulation: Mirrors and Modules\n",
+    "# 22 - Mirrors and Modules\n",
     "\n",
     "\n",
     "Doing an example tutorial for example brought up in Issue #372\n",

diff --git a/docs/tutorials/22 - Mirrors and Modules.py b/docs/tutorials/22 - Mirrors and Modules.py
@@ -1,9 +1,7 @@
 #!/usr/bin/env python
 # coding: utf-8
 
-# <a id='step1'></a>
-
-# # 22 - Example Simulation: Mirrors and Modules
+# # 22 - Mirrors and Modules
 # 
 # 
 # Doing an example tutorial for example brought up in Issue #372

diff --git a/docs/tutorials/3 - Single Axis Tracking Hourly.ipynb b/docs/tutorials/3 - Single Axis Tracking Hourly.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 3 - Medium Level Example - 1-Axis tracker by hour (gendaylit)\n",
+    "# 3 - Single Axis Tracking Hourly\n",
     "\n",
     "Example demonstrating the use of doing hourly smiulations with Radiance gendaylit for 1-axis tracking. This is a medium level example because it also explores a couple subtopics:\n",
     "\n",

diff --git a/docs/tutorials/3 - Single Axis Tracking Hourly.py b/docs/tutorials/3 - Single Axis Tracking Hourly.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # coding: utf-8
 
-# # 3 - Medium Level Example - 1-Axis tracker by hour (gendaylit)
+# # 3 - Single Axis Tracking Hourly
 # 
 # Example demonstrating the use of doing hourly smiulations with Radiance gendaylit for 1-axis tracking. This is a medium level example because it also explores a couple subtopics:
 # 

diff --git a/docs/tutorials/4 - Debugging with Custom Objects.ipynb b/docs/tutorials/4 - Debugging with Custom Objects.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 4 - Medium Level Example - Debugging your Scene with Custom Objects\n",
+    "# 4 - Debugging with Custom Objects\n",
     "## Fixed Tilt 2-up with Torque Tube + CLEAN Routine + CustomObject\n",
     "\n",
     "This journal has examples of various things, some which hav ebeen covered before and some in more depth:\n",

diff --git a/docs/tutorials/4 - Debugging with Custom Objects.py b/docs/tutorials/4 - Debugging with Custom Objects.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # coding: utf-8
 
-# # 4 - Medium Level Example - Debugging your Scene with Custom Objects
+# # 4 - Debugging with Custom Objects
 # ## Fixed Tilt 2-up with Torque Tube + CLEAN Routine + CustomObject
 # 
 # This journal has examples of various things, some which hav ebeen covered before and some in more depth:

diff --git a/docs/tutorials/5 - Bifacial Carports and Canopies.ipynb b/docs/tutorials/5 - Bifacial Carports and Canopies.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 5 - Medium Level Example - Modeling Carports and Canopies + Sampling accross a Module!\n",
+    "# 5 - Bifacial Carports and Canopies\n",
     "\n",
     "This journal shows how to model a carport or canopy ~ a fixed structure, usually at a high clearance from the ground, with more than one bifacial solar module in the same inclined-plane to create a \"shade\" for the cars/people below.\n",
     "\n",

diff --git a/docs/tutorials/5 - Bifacial Carports and Canopies.py b/docs/tutorials/5 - Bifacial Carports and Canopies.py
@@ -1,7 +1,7 @@
 #!/usr/bin/env python
 # coding: utf-8
 
-# # 5 - Medium Level Example - Modeling Carports and Canopies + Sampling accross a Module!
+# # 5 - Bifacial Carports and Canopies
 # 
 # This journal shows how to model a carport or canopy ~ a fixed structure, usually at a high clearance from the ground, with more than one bifacial solar module in the same inclined-plane to create a "shade" for the cars/people below.
 # 

diff --git a/docs/tutorials/6 - Exploring Trackerdict Structure.ipynb b/docs/tutorials/6 - Exploring Trackerdict Structure.ipynb
@@ -4,7 +4,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "# 6 - Advanced topics: Understanding trackerdict structure\n",
+    "# 6 - Exploring Trackerdict Structure\n",
     "\n",
     "Tutorial 6 gives a good, detailed introduction to the trackerdict structure step by step.\n",
     "Here is a condensed summary of functions you can use to explore the tracker dictionary.\n",
@@ -445,7 +445,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.8"
+   "version": "3.9.13"
   }
  },
  "nbformat": 4,