Skip to content

Commit e105486

Browse files
kandersolarkandersolar
authored
Organize example gallery into sections (#1351)
* reorg examples folder into subfolders by topic * don't use spaces in folder names * add subfolder READMEs * fix broken image paths * fix the things that ms windows broke
1 parent 9871868 commit e105486

25 files changed

+24
-4
lines changed

‎docs/examples/irradiance-transposition/README.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Irradiance Transposition
2+
------------------------
3+

‎docs/examples/plot_ghi_transposition.py renamed to ‎docs/examples/irradiance-transposition/plot_ghi_transposition.py

File renamed without changes.

‎docs/examples/plot_interval_transposition_error.py renamed to ‎docs/examples/irradiance-transposition/plot_interval_transposition_error.py

File renamed without changes.

‎docs/examples/plot_mixed_orientation.py renamed to ‎docs/examples/irradiance-transposition/plot_mixed_orientation.py

File renamed without changes.

‎docs/examples/plot_seasonal_tilt.py renamed to ‎docs/examples/irradiance-transposition/plot_seasonal_tilt.py

File renamed without changes.

‎docs/examples/plot_transposition_gain.py renamed to ‎docs/examples/irradiance-transposition/plot_transposition_gain.py

File renamed without changes.

‎docs/examples/iv-modeling/README.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
I-V Modeling
2+
------------
3+

‎docs/examples/plot_singlediode.py renamed to ‎docs/examples/iv-modeling/plot_singlediode.py

File renamed without changes.

‎docs/examples/reflections/README.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Reflections
2+
-----------
3+

‎docs/examples/plot_diffuse_aoi_correction.py renamed to ‎docs/examples/reflections/plot_diffuse_aoi_correction.py

File renamed without changes.

‎docs/examples/shading/README.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Shading
2+
-------

‎docs/examples/plot_partial_module_shading_simple.py renamed to ‎docs/examples/shading/plot_partial_module_shading_simple.py

File renamed without changes.

‎docs/examples/plot_passias_diffuse_shading.py renamed to ‎docs/examples/shading/plot_passias_diffuse_shading.py

File renamed without changes.

‎docs/examples/soiling/README.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Soiling
2+
-------

‎docs/examples/plot_fig3A_hsu_soiling_example.py renamed to ‎docs/examples/soiling/plot_fig3A_hsu_soiling_example.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@
7171
# %%
7272
# Here is the original figure from [1]_ for comparison:
7373
#
74-
# .. image:: ../_images/Coello_Boyle_2019_Fig3.png
74+
# .. image:: ../../_images/Coello_Boyle_2019_Fig3.png
7575
# :alt: Figure 3A from the paper showing a simulated soiling signal.
7676
#
7777
# Note that this figure shows additional timeseries not calculated here:

‎docs/examples/plot_greensboro_kimber_soiling.py renamed to ‎docs/examples/soiling/plot_greensboro_kimber_soiling.py

File renamed without changes.

‎docs/examples/solar-position/README.rst

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,3 @@
1+
Solar Position
2+
--------------
3+

‎docs/examples/plot_sunpath_diagrams.py renamed to ‎docs/examples/solar-position/plot_sunpath_diagrams.py

File renamed without changes.

‎docs/examples/solar-tracking/README.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Solar Tracking
2+
--------------

‎docs/examples/plot_discontinuous_tracking.py renamed to ‎docs/examples/solar-tracking/plot_discontinuous_tracking.py

File renamed without changes.

‎docs/examples/plot_dual_axis_tracking.py renamed to ‎docs/examples/solar-tracking/plot_dual_axis_tracking.py

File renamed without changes.

‎docs/examples/plot_single_axis_tracking.py renamed to ‎docs/examples/solar-tracking/plot_single_axis_tracking.py

File renamed without changes.

‎docs/examples/plot_single_axis_tracking_on_sloped_terrain.py renamed to ‎docs/examples/solar-tracking/plot_single_axis_tracking_on_sloped_terrain.py

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@
3131
# two choices for the axis azimuth angle, and by convention (at least in the
3232
# northern hemisphere), the more southward angle is chosen:
3333
#
34-
# .. image:: ../_images/tracker_azimuth_angle_convention.png
34+
# .. image:: ../../_images/tracker_azimuth_angle_convention.png
3535
# :alt: Image showing the azimuth convention for single-axis tracker arrays.
3636
# :width: 500
3737
# :align: center
@@ -48,7 +48,7 @@
4848
# Point the right hand thumb along the axis in the direction of the axis
4949
# azimuth and the fingers curl in the direction of positive rotation angle:
5050
#
51-
# .. image:: ../_images/tracker_rotation_angle_convention.png
51+
# .. image:: ../../_images/tracker_rotation_angle_convention.png
5252
# :alt: Image showing the rotation sign convention for single-axis trackers.
5353
# :width: 500
5454
# :align: center
@@ -66,7 +66,7 @@
6666
# with the axis azimuth coming out of the page, an east-facing, downward slope
6767
# is a negative rotation from horizontal:
6868
#
69-
# .. image:: ../_images/ground_slope_angle_convention.png
69+
# .. image:: ../../_images/ground_slope_angle_convention.png
7070
# :alt: Image showing the ground slope sign convention.
7171
# :width: 500
7272
# :align: center

‎docs/examples/spectrum/README.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,2 @@
1+
Spectrum
2+
--------

‎docs/examples/plot_spectrl2_fig51A.py renamed to ‎docs/examples/spectrum/plot_spectrl2_fig51A.py

File renamed without changes.

0 commit comments

Comments
 (0)