Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@shirubana
shirubana committed Dec 4, 2023
1 parent 445efc8 commit 6019059
Show file tree
Hide file tree
Showing 8 changed files with 57 additions and 260 deletions.
173 changes: 35 additions & 138 deletions _sources/tutorials/2 - bifacial_radiance Basic AgriPV Example.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -96,7 +96,7 @@
},
{
"cell_type": "code",
"execution_count": 1,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -107,20 +107,9 @@
},
{
"cell_type": "code",
"execution_count": 2,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Working on a Windows 10\n",
"Python version 3.11.4 | packaged by Anaconda, Inc. | (main, Jul 5 2023, 13:38:37) [MSC v.1916 64 bit (AMD64)]\n",
"Pandas version 2.1.0\n",
"bifacial_radiance version 0.4.2+223.g58332d6.dirty\n"
]
}
],
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"# This information helps with debugging and getting support :)\n",
"import sys, platform\n",
Expand All @@ -132,17 +121,9 @@
},
{
"cell_type": "code",
"execution_count": 3,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Your simulation will be stored in TEMP\n"
]
}
],
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"import os\n",
"from pathlib import Path\n",
Expand All @@ -157,17 +138,9 @@
},
{
"cell_type": "code",
"execution_count": 4,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"path = TEMP\n"
]
}
],
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"demo = br.RadianceObj('AgriPV_example',path = testfolder) "
]
Expand All @@ -181,23 +154,9 @@
},
{
"cell_type": "code",
"execution_count": 5,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Getting weather file: ARE_Abu.Dhabi.412170_IWEC.epw\n",
" ... OK!\n",
"8760 line in WeatherFile. Assuming this is a standard hourly WeatherFile for the year for purposes of saving Gencumulativesky temporary weather files in EPW folder.\n",
"Coercing year to 2023\n",
"Filtering dates\n",
"Saving file EPWs\\metdata_temp.csv, # points: 8760\n",
"Calculating Sun position for Metdata that is right-labeled with a delta of -30 mins. i.e. 12 is 11:30 sunpos\n"
]
}
],
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"#Valid options: mm_dd, mm_dd_HH, mm_dd_HHMM, YYYY-mm-dd_HHMM\n",
"epwfile = demo.getEPW(25.2854, 51.5310) # Doha!\n",
Expand All @@ -213,19 +172,9 @@
},
{
"cell_type": "code",
"execution_count": 6,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
" Assigned Albedo from metdata.albedo\n",
"Loading albedo, 11 value(s), 0.000 avg\n",
"0 nonzero albedo values.\n"
]
}
],
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"demo.setGround() # You can pass a value for fixed value, or empty it will grab the albedo column from the weatherdata "
]
Expand All @@ -246,21 +195,9 @@
},
{
"cell_type": "code",
"execution_count": 7,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"\n",
"Module Name: 3-up-collector\n",
"Module 3-up-collector updated in module.json\n",
"Pre-existing .rad file objects\\3-up-collector.rad will be overwritten\n",
"\n"
]
}
],
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"# MakeModule Parameters\n",
"modulename='3-up-collector'\n",
Expand Down Expand Up @@ -299,20 +236,9 @@
},
{
"cell_type": "code",
"execution_count": 9,
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"'skies\\\\sky2_24.43_54.65_2023-12-04_1300.rad'"
]
},
"execution_count": 9,
"metadata": {},
"output_type": "execute_result"
}
],
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"timeindex = metdata.datetime.index(pd.to_datetime('2023-12-04 13:00:0 +4')) # Make this timezone aware, use -5 for EST.\n",
"demo.gendaylit(timeindex) "
Expand All @@ -327,7 +253,7 @@
},
{
"cell_type": "code",
"execution_count": 10,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand Down Expand Up @@ -355,17 +281,9 @@
},
{
"cell_type": "code",
"execution_count": 11,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Created AgriPV_example.oct\n"
]
}
],
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"octfile = demo.makeOct()"
]
Expand All @@ -381,7 +299,7 @@
},
{
"cell_type": "code",
"execution_count": 12,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand Down Expand Up @@ -409,7 +327,7 @@
},
{
"cell_type": "code",
"execution_count": 13,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -419,19 +337,9 @@
},
{
"cell_type": "code",
"execution_count": 14,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Linescan in process: _modulescan_Row2_Module1_Front\n",
"Linescan in process: _modulescan_Row2_Module1_Back\n",
"Saved: results\\irr__modulescan_Row2_Module1.csv\n"
]
}
],
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"moduleresultsfront, moduleresultsback = analysis.analysis(octfile, \"_modulescan\", frontscan, backscan) # compare the back vs front irradiance"
]
Expand All @@ -445,7 +353,7 @@
},
{
"cell_type": "code",
"execution_count": 15,
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -455,20 +363,9 @@
},
{
"cell_type": "code",
"execution_count": 16,
"metadata": {},
"outputs": [
{
"name": "stdout",
"output_type": "stream",
"text": [
"Linescan in process: _groundscan_Row2_Module3_Front\n",
"Linescan in process: _groundscan_Row2_Module3_Back\n",
"Saved: results\\irr__groundscan_Row2_Module3_Front.csv\n",
"Saved: results\\irr__groundscan_Row2_Module3_Back.csv\n"
]
}
],
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"groundresults, moduleresultsback = analysis.analysis(octfile, \"_groundscan\", groundscan, backscan) # compare the back vs front irradiance "
]
Expand Down
8 changes: 4 additions & 4 deletions ...orials/3 - bifacial_radiance Mandy Lewis bifiPV Talk Reflector Optimization Example.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -278,7 +278,7 @@
"id": "48253c92",
"metadata": {},
"source": [
"# Run bifacial_radiance comparison \n"
"## Run bifacial_radiance comparison \n"
]
},
{
Expand Down Expand Up @@ -492,7 +492,7 @@
"id": "65d6a260",
"metadata": {},
"source": [
"# Summarize output data in pandas dataframe"
"## Summarize output data in pandas dataframe"
]
},
{
Expand Down Expand Up @@ -1244,7 +1244,7 @@
"id": "5762a28c",
"metadata": {},
"source": [
"# Calculate a few metrics for entire run"
"## Calculate a few metrics for entire run"
]
},
{
Expand Down Expand Up @@ -1295,7 +1295,7 @@
"id": "6efd7791",
"metadata": {},
"source": [
"# Plot results - single day example"
"## Plot results - single day example"
]
},
{
Expand Down
4 changes: 0 additions & 4 deletions genindex.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -167,10 +167,6 @@
<li class="toctree-l1"><a class="reference internal" href="tutorials/1%20-%20NSRDB%20Weather%20Data%20to%20Array%20Power%20with%20PVLib.html">Tutorial 1 &amp; 5 - NSRDB Weather Data to Array Power with PVLib</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/2%20-%20bifacial_radiance%20Basic%20AgriPV%20Example.html">2 - bifacial_radiance Basic AgriPV Example</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/3%20-%20bifacial_radiance%20Mandy%20Lewis%20bifiPV%20Talk%20Reflector%20Optimization%20Example.html">3 - bifacial_radiance Mandy Lewis bifiPV Talk:</a></li>




</ul>

</div>
Expand Down
8 changes: 0 additions & 8 deletions intro.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,10 +169,6 @@
<li class="toctree-l1"><a class="reference internal" href="tutorials/1%20-%20NSRDB%20Weather%20Data%20to%20Array%20Power%20with%20PVLib.html">Tutorial 1 &amp; 5 - NSRDB Weather Data to Array Power with PVLib</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/2%20-%20bifacial_radiance%20Basic%20AgriPV%20Example.html">2 - bifacial_radiance Basic AgriPV Example</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/3%20-%20bifacial_radiance%20Mandy%20Lewis%20bifiPV%20Talk%20Reflector%20Optimization%20Example.html">3 - bifacial_radiance Mandy Lewis bifiPV Talk:</a></li>




</ul>

</div>
Expand Down Expand Up @@ -383,10 +379,6 @@ <h1>Welcome to the interactive bifacial_radiance Training<a class="headerlink" h
<li class="toctree-l1"><a class="reference internal" href="tutorials/1%20-%20NSRDB%20Weather%20Data%20to%20Array%20Power%20with%20PVLib.html">Tutorial 1 &amp; 5 - NSRDB Weather Data to Array Power with PVLib</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/2%20-%20bifacial_radiance%20Basic%20AgriPV%20Example.html">2 - bifacial_radiance Basic AgriPV Example</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/3%20-%20bifacial_radiance%20Mandy%20Lewis%20bifiPV%20Talk%20Reflector%20Optimization%20Example.html">3 - bifacial_radiance Mandy Lewis bifiPV Talk:</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/3%20-%20bifacial_radiance%20Mandy%20Lewis%20bifiPV%20Talk%20Reflector%20Optimization%20Example.html#run-bifacial-radiance-comparison">Run bifacial_radiance comparison</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/3%20-%20bifacial_radiance%20Mandy%20Lewis%20bifiPV%20Talk%20Reflector%20Optimization%20Example.html#summarize-output-data-in-pandas-dataframe">Summarize output data in pandas dataframe</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/3%20-%20bifacial_radiance%20Mandy%20Lewis%20bifiPV%20Talk%20Reflector%20Optimization%20Example.html#calculate-a-few-metrics-for-entire-run">Calculate a few metrics for entire run</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/3%20-%20bifacial_radiance%20Mandy%20Lewis%20bifiPV%20Talk%20Reflector%20Optimization%20Example.html#plot-results-single-day-example">Plot results - single day example</a></li>
</ul>
</div>
</section>
Expand Down
4 changes: 0 additions & 4 deletions search.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -169,10 +169,6 @@
<li class="toctree-l1"><a class="reference internal" href="tutorials/1%20-%20NSRDB%20Weather%20Data%20to%20Array%20Power%20with%20PVLib.html">Tutorial 1 &amp; 5 - NSRDB Weather Data to Array Power with PVLib</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/2%20-%20bifacial_radiance%20Basic%20AgriPV%20Example.html">2 - bifacial_radiance Basic AgriPV Example</a></li>
<li class="toctree-l1"><a class="reference internal" href="tutorials/3%20-%20bifacial_radiance%20Mandy%20Lewis%20bifiPV%20Talk%20Reflector%20Optimization%20Example.html">3 - bifacial_radiance Mandy Lewis bifiPV Talk:</a></li>




</ul>

</div>
Expand Down
2 changes: 1 addition & 1 deletion searchindex.js
View file

Large diffs are not rendered by default.

Loading

0 comments on commit 6019059

Please sign in to comment.