diff --git a/docs/sphinx/source/examples.rst b/docs/sphinx/source/examples.rst index 160cde9f..a5fb286d 100644 --- a/docs/sphinx/source/examples.rst +++ b/docs/sphinx/source/examples.rst @@ -62,7 +62,7 @@ AgriPV Other Examples -------=------- +-------------- .. nbgallery:: diff --git a/docs/tutorials/1 - Fixed Tilt Yearly Results.ipynb b/docs/tutorials/1 - Fixed Tilt Yearly Results.ipynb index ceab1928..752b5064 100644 --- a/docs/tutorials/1 - Fixed Tilt Yearly Results.ipynb +++ b/docs/tutorials/1 - Fixed Tilt Yearly Results.ipynb @@ -43,7 +43,7 @@ "\n", "The lines below find the location of the folder relative to this Jupyter Journa. You can alternatively point to an empty directory (it will open a load GUI Visual Interface) or specify any other directory in your computer, for example:\n", "\n", - "***testfolder = r'C:\\Users\\sayala\\Documents\\RadianceScenes\\Tutorials\\Journal1'***\n", + "> testfolder = r'C:\\Users\\sayala\\Documents\\RadianceScenes\\Tutorials\\Journal1'\n", "\n" ] }, @@ -823,7 +823,7 @@ "\n", "If you used gencumsky or gendaylit, you can view the Scene by navigating on a command line to the folder and typing:\n", "\n", - "***objview materials\\ground.rad objects\\test-module_C_0.20000_rtr_3.00000_tilt_10.00000_20modsx7rows_origin0,0.rad***\n" + "> objview materials\\ground.rad objects\\test-module_C_0.20000_rtr_3.00000_tilt_10.00000_20modsx7rows_origin0,0.rad\n" ] }, { @@ -847,7 +847,7 @@ "\n", "ONLY If you used gendaylit , you can view the scene correctly illuminated with the sky you generated after generating the oct file, with \n", "\n", - "***rvu -vf views\\front.vp -e .01 tutorial_1.oct***" + "> rvu -vf views\\front.vp -e .01 tutorial_1.oct" ] }, { diff --git a/docs/tutorials/11 - AgriPV Systems.ipynb b/docs/tutorials/11 - AgriPV Systems.ipynb index 7ed2fec3..a9316536 100644 --- a/docs/tutorials/11 - AgriPV Systems.ipynb +++ b/docs/tutorials/11 - AgriPV Systems.ipynb @@ -194,7 +194,7 @@ "source": [ "If desired, you can view the Oct file at this point:\n", "\n", - "***rvu -vf views\\front.vp -e .01 tutorial_11.oct***" + "**rvu -vf views\\front.vp -e .01 tutorial_11.oct**" ] }, { @@ -312,7 +312,7 @@ "source": [ "### View the geometry with the posts on :\n", "\n", - "***rvu -vf views\\front.vp -e .01 -pe 0.4 -vp 12 -10 3.5 -vd -0.0995 0.9950 0.0 tutorial_11.oct***\n", + "**rvu -vf views\\front.vp -e .01 -pe 0.4 -vp 12 -10 3.5 -vd -0.0995 0.9950 0.0 tutorial_11.oct**\n", "\n" ] }, diff --git a/docs/tutorials/13 - Modeling Modules with Glass.ipynb b/docs/tutorials/13 - Modeling Modules with Glass.ipynb index 143004f4..c0247b06 100644 --- a/docs/tutorials/13 - Modeling Modules with Glass.ipynb +++ b/docs/tutorials/13 - Modeling Modules with Glass.ipynb @@ -165,40 +165,40 @@ "\n", "In detail:\n", "\n", - "***1. Use rvu to view the oct file***\n", + "**1. Use rvu to view the oct file**\n", "\n", " rvu 1axis_07_01_08.oct \n", "\n", "Use aim and origin to move around, zoom in/out, etc. Save a view file with view render.\n", "\n", - "***2. Run rpict to render the image to hdr***\n", + "**2. Run rpict to render the image to hdr**\n", "\n", "This is the time consuming step. It takes between 1 and 3 hours depending on how complex the geometry is.\n", "\n", " rpict -x 4800 -y 4800 -i -ps 1 -dp 530 -ar 964 -ds 0.016 -dj 1 -dt 0.03 -dc 0.9 -dr 5 -st 0.12 -ab 5 -aa 0.11 -ad 5800 -as 5800 -av 25 25 25 -lr 14 -lw 0.0002 -vf render.vf bifacial_example.oct > render.hdr\n", "\n", "\n", - "***3. Run pcond to mimic human visual response***\n", + "**3. Run pcond to mimic human visual response**\n", "\n", " pcond -h render.hdr > render.pcond.hdr\n", "\n", "\n", - "***4. Resize and adjust exposure with pfilt***\n", + "**4. Resize and adjust exposure with pfilt**\n", "\n", " pfilt -e +0.2 -x /4 -y /4 render.pcond.hdr > render.pcond.pfilt.hdr\n", "\n", "\n", - "***5. Convert hdr to tif***\n", + "**5. Convert hdr to tif**\n", "\n", " ra_tiff render.pcond.pfilt.hdr render.tif\n", "\n", "\n", - "***6. Convert tif to png with imagemagick convert utility***\n", + "**6. Convert tif to png with imagemagick convert utility**\n", "\n", " convert render.tif render.png\n", "\n", "\n", - "***7. Annotate the image with convert***\n", + "**7. Annotate the image with convert**\n", "\n", " convert render.png -fill black -gravity South -annotate +0+5 'Created with NREL bifacial_radiance https://github.com/NREL/bifacial_radiance' render_annotated.png\n" ] diff --git a/docs/tutorials/18 - AgriPV - Coffee Plantation with Tree Modeling.ipynb b/docs/tutorials/18 - AgriPV - Coffee Plantation with Tree Modeling.ipynb index 3cef9c51..130b4c5e 100644 --- a/docs/tutorials/18 - AgriPV - Coffee Plantation with Tree Modeling.ipynb +++ b/docs/tutorials/18 - AgriPV - Coffee Plantation with Tree Modeling.ipynb @@ -736,7 +736,7 @@ "id": "9501f465", "metadata": {}, "source": [ - "***Now you can view the Geometry by navigating on the terminal to the testfolder, and using the octfile name generated above***\n", + "**Now you can view the Geometry by navigating on the terminal to the testfolder, and using the octfile name generated above**\n", "\n", ">rvu -vf views\\front.vp -e .0265652 -vp 2 -21 2.5 -vd 0 1 0 Coffee_ch_1.8_xgap_1.2_tilt_18_pitch_2.2.oct" ] diff --git a/docs/tutorials/2 - Single Axis Tracking Yearly Simulation.ipynb b/docs/tutorials/2 - Single Axis Tracking Yearly Simulation.ipynb index f0b4d713..76314f74 100644 --- a/docs/tutorials/2 - Single Axis Tracking Yearly Simulation.ipynb +++ b/docs/tutorials/2 - Single Axis Tracking Yearly Simulation.ipynb @@ -16,7 +16,7 @@ "Ayala Pelaez S, Deline C, Greenberg P, Stein JS, Kostuk RK. Model and validation of single-axis tracking with bifacial PV. IEEE J Photovoltaics. 2019;9(3):715–21. https://ieeexplore.ieee.org/document/8644027 and https://www.nrel.gov/docs/fy19osti/72039.pdf (pre-print, conference version)\n", "\n", "\n", - "***Steps:***\n", + "**Steps:**\n", "1. Create a folder for your simulation, and load bifacial_radiance \n", "2. Create a Radiance Object, set Albedo and Download Weather Files \n", "4. Set Tracking Angles \n", @@ -49,7 +49,7 @@ "\n", "The lines below find the location of the folder relative to this Jupyter Journal. You can alternatively point to an empty directory (it will open a load GUI Visual Interface) or specify any other directory in your computer, for example:\n", "\n", - "***testfolder = r'C:\\Users\\sayala\\Documents\\RadianceScenes\\Tutorials\\Journal2'***\n", + "**testfolder = r'C:\\Users\\sayala\\Documents\\RadianceScenes\\Tutorials\\Journal2'**\n", "\n" ] }, diff --git a/docs/tutorials/3 - Single Axis Tracking Hourly.ipynb b/docs/tutorials/3 - Single Axis Tracking Hourly.ipynb index c20aac5c..78d8c4ec 100644 --- a/docs/tutorials/3 - Single Axis Tracking Hourly.ipynb +++ b/docs/tutorials/3 - Single Axis Tracking Hourly.ipynb @@ -8,17 +8,17 @@ "\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", - "***Subtopics:***\n", + "**Subtopics:**\n", "* The structure of the tracker dictionary \"trackerDict\".\n", "* How to calculate GCR \n", "* How to make a cell-level module\n", "* Various methods to use the trackerdictionary for analysis.\n", " \n", - "***Doing full year simulations with gendaylit:***\n", + "**Doing full year simulations with gendaylit:**\n", "\n", "Performing the simulation hour by hour requires either a good computer or some patience, since there are ~4000 daylight-hours in the year. With a 32GB RAM, Windows 10 i7-8700 CPU @ 3.2GHz with 6 cores this takes 1 day. The code also allows for multiple cores or HPC use -- there is documentation/examples inside the software at the moment, but that is an advanced topic. The procedure can be broken into shorter steps for one day or a single timestamp simulation which is exemplified below.\n", "\n", - "***Steps:***\n", + "**Steps:**\n", "1. Load bifacial_radiance \n", "2. Define all your system variables \n", "3. Create Radiance Object, Set Albedo and Weather \n", diff --git a/docs/tutorials/4 - Debugging with Custom Objects.ipynb b/docs/tutorials/4 - Debugging with Custom Objects.ipynb index 69a6c77c..8f935ffa 100644 --- a/docs/tutorials/4 - Debugging with Custom Objects.ipynb +++ b/docs/tutorials/4 - Debugging with Custom Objects.ipynb @@ -19,7 +19,7 @@ "\n", "![What we are trying to re-create](../images_wiki/Journal_example_torquetube.PNG)\n", "\n", - "***STEPS:***\n", + "**STEPS:**\n", "\n", "1. Specify Working Folder and Import Program \n", "2. Specify all variables \n", @@ -303,7 +303,7 @@ "source": [ "At this point you should be able to go into a command window (cmd.exe) and check the geometry. It should look like the image at the beginning of the journal. Example:\n", " \n", - "***rvu -vf views\\front.vp -e .01 -pe 0.02 -vp -2 -12 14.5 tutorial_4.oct****\n" + "**rvu -vf views\\front.vp -e .01 -pe 0.02 -vp -2 -12 14.5 tutorial_4.oct***\n" ] }, { @@ -821,7 +821,7 @@ "\n", "If you do an analysis and any of the sensors hits the Box object we just created, the list of materials in the result.csv file should say something with \"CenterMarker\" on it. \n", "\n", - "***See more examples of the use of makeCustomObject and appendtoScene on the Bifacial Carport/Canopies Tutorial*** " + "**See more examples of the use of makeCustomObject and appendtoScene on the Bifacial Carport/Canopies Tutorial** " ] } ], diff --git a/docs/tutorials/5 - Bifacial Carports and Canopies.ipynb b/docs/tutorials/5 - Bifacial Carports and Canopies.ipynb index 22e3aaba..179b56f4 100644 --- a/docs/tutorials/5 - Bifacial Carports and Canopies.ipynb +++ b/docs/tutorials/5 - Bifacial Carports and Canopies.ipynb @@ -225,7 +225,7 @@ "source": [ "### View the geometry with the posts on :\n", "\n", - "***rvu -vf views\\front.vp -e .01 -pe 0.4 -vp 3.5 -20 22 tutorial_5.oct***\n", + "**rvu -vf views\\front.vp -e .01 -pe 0.4 -vp 3.5 -20 22 tutorial_5.oct**\n", "\n", "-pe sets the exposure levels, and -vp sets the view point so the carport is centered (at least on my screen. you can play with the values). It should look like this:\n", "\n", diff --git a/docs/tutorials/6 - Exploring Trackerdict Structure.ipynb b/docs/tutorials/6 - Exploring Trackerdict Structure.ipynb index 393e417b..48e63963 100644 --- a/docs/tutorials/6 - Exploring Trackerdict Structure.ipynb +++ b/docs/tutorials/6 - Exploring Trackerdict Structure.ipynb @@ -10,7 +10,7 @@ "Here is a condensed summary of functions you can use to explore the tracker dictionary.\n", "\n", "\n", - "***Steps:***\n", + "**Steps:**\n", "\n", "1. Create a short Simulation + tracker dictionary beginning to end for 1 day \n", "2. Explore the tracker dictionary \n", diff --git a/docs/tutorials/Webinar_Slides.ipynb b/docs/tutorials/Webinar_Slides.ipynb index dfd3959f..e2b8bbff 100644 --- a/docs/tutorials/Webinar_Slides.ipynb +++ b/docs/tutorials/Webinar_Slides.ipynb @@ -1206,13 +1206,13 @@ "\n", "If you used gencumsky or gendaylit, you can view the Scene by navigating on a command line to the folder and typing:\n", "\n", - "***objview materials\\ground.rad objects\\Prism_Solar_Bi60_landscape_0.2_3_10_20x7_origin0,0.rad*** \n", + "**objview materials\\ground.rad objects\\Prism_Solar_Bi60_landscape_0.2_3_10_20x7_origin0,0.rad** \n", "\n", "This objview has 3 different light sources of its own, so the shading is not representative.\n", "\n", "ONLY If you used gendaylit , you can view the scene correctly illuminated with the sky you generated after generating the oct file, with \n", "\n", - "***rvu -vf views\\front.vp -e .01 bifacial_example.oct***\n", + "**rvu -vf views\\front.vp -e .01 bifacial_example.oct**\n", "\n", "The rvu manual can be found here: manual page here: http://radsite.lbl.gov/radiance/rvu.1.html\n" ]