Skip to content

Commit

Permalink
Add gallery example for simple irradiance adjustment for horizon shad…
Browse files Browse the repository at this point in the history 
…ing (#1849)

* pvgis gallery example

Adding gallery example of how to use the PVGIS get_horizon_data function.

* name_update

* updates_1

* Update 2

Adjusted to the broader 'simple irradiance...shading' rebrand, use hard-coded horizon profile data, and give example of how to get such data from PVGIS function in IO Tools.

* update 3

Updated whatsnew file with pull #. Updated formatting and other minor syntax in .py file.

* Update docs/sphinx/source/whatsnew/v0.10.2.rst

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update docs/examples/shading/plot_simple_irradiance_adjustment_for_horizon_shading.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update docs/examples/shading/plot_simple_irradiance_adjustment_for_horizon_shading.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update docs/examples/shading/plot_simple_irradiance_adjustment_for_horizon_shading.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update docs/examples/shading/plot_simple_irradiance_adjustment_for_horizon_shading.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update docs/examples/shading/plot_simple_irradiance_adjustment_for_horizon_shading.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update docs/examples/shading/plot_simple_irradiance_adjustment_for_horizon_shading.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update docs/examples/shading/plot_simple_irradiance_adjustment_for_horizon_shading.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update docs/examples/shading/plot_simple_irradiance_adjustment_for_horizon_shading.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* flake8 updates

* Update docs/examples/shading/plot_simple_irradiance_adjustment_for_horizon_shading.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* Update docs/examples/shading/plot_simple_irradiance_adjustment_for_horizon_shading.py

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>

* update

Corrected docstring text

---------

Co-authored-by: Adam R. Jensen <39184289+AdamRJensen@users.noreply.github.com>
  • Loading branch information
@spaneja @AdamRJensen
spaneja and AdamRJensen authored Sep 19, 2023
1 parent 7fe065f commit 9b4317e
Show file tree
Hide file tree
Showing 2 changed files with 121 additions and 0 deletions.
118 changes: 118 additions & 0 deletions docs/examples/shading/plot_simple_irradiance_adjustment_for_horizon_shading.py
View file
Original file line number Diff line number Diff line change
@@ -0,0 +1,118 @@
"""
Simple irradiance adjustment for horizon shading
================================================
Example of applying horizon shading to dni and global poa. Using
horizon profile data, this example interpolates it to time-series
solar-position data, and adjust DNI and POA-global irradiance.
"""

# %%
# This example shows how to use horizon elevation angles with
# corresponding horizon azimuth angles for simple horizon shading adjustments.
#
# After location information and a date range is established, solar position
# data is calculated using :py:func:`pvlib.solarposition.get_solarposition`.
# Horizon data is assigned, and interpolated to the solar azimuth time
# series data. Finally, in times when solar elevation is greater than the
# interpolated horizon elevation angle, DNI is set to 0.

import numpy as np
import pandas as pd
import pvlib

# Golden, CO
latitude, longitude = 39.76, -105.22
tz = 'MST'

# Set times in the morning of the December solstice.
times = pd.date_range(
'2020-12-20 6:30', '2020-12-20 9:00', freq='1T', tz=tz
)

# Create location object, and get solar position and clearsky irradiance data.
location = pvlib.location.Location(latitude, longitude, tz)
solar_position = location.get_solarposition(times)
clearsky = location.get_clearsky(times)

# Assign variable names for easier reading.
surface_tilt = 30
surface_azimuth = 180
solar_azimuth = solar_position.azimuth
solar_zenith = solar_position.apparent_zenith
solar_elevation = solar_position.apparent_elevation
dni = clearsky.dni
ghi = clearsky.ghi
dhi = clearsky.dhi

# %%
# With basic inputs in place, let's perform the adjustment for horizon shading:

# Use hard-coded horizon profile data from location object above.
horizon_profile = pd.Series([
10.7, 11.8, 11.5, 10.3, 8.0, 6.5, 3.8, 2.3, 2.3, 2.3, 4.6, 8.0, 10.3, 11.1,
10.7, 10.3, 9.2, 6.1, 5.3, 2.3, 3.1, 1.9, 1.9, 2.7, 3.8, 5.3, 6.5, 8.4,
8.8, 8.4, 8.4, 8.4, 6.5, 6.1, 6.5, 6.1, 7.3, 9.2, 8.4, 8.0, 5.7, 5.3, 5.3,
4.2, 4.2, 4.2, 7.3, 9.5
], index=np.arange(0, 360, 7.5))

ax = horizon_profile.plot(xlim=(0, 360), ylim=(0, None), figsize=(6, 2.5))
ax.set_title('Horizon profile')
ax.set_xticks([0, 90, 180, 270, 360])
ax.set_xlabel('Azimuth [°]')
ax.set_ylabel('Horizon angle [°]')

# %%
# .. admonition:: Horizon data from PVGIS
#
# Example of how to get the above horizon data from PVGIS
#
# horizon_profile, horizon_metadata = pvlib.iotools.get_pvgis_horizon(
# latitutde, longitude)
#

# Interpolate the horizon elevation data to the solar azimuth, and keep as a
# numpy array.
horizon_elevation_data = np.interp(
solar_azimuth, horizon_profile.index, horizon_profile
)

# Convert to Pandas Series for easier usage.
horizon_elevation_data = pd.Series(horizon_elevation_data, times)

# Adjust DNI based on data - note this is returned as numpy array
dni_adjusted = np.where(solar_elevation > horizon_elevation_data, dni, 0)

# Adjust GHI and set it to DHI for time-periods where 'dni_adjusted' is 0.
# Note this is returned as numpy array
ghi_adjusted = np.where(dni_adjusted == 0, dhi, ghi)

# Transposition using the original and adjusted irradiance components.
irrad_pre_adj = pvlib.irradiance.get_total_irradiance(
surface_tilt, surface_azimuth, solar_zenith, solar_azimuth, dni, ghi, dhi
)

irrad_post_adj = pvlib.irradiance.get_total_irradiance(
surface_tilt, surface_azimuth, solar_zenith, solar_azimuth, dni_adjusted,
ghi_adjusted, dhi
)

# Create and plot result DataFrames.
poa_global_comparison = pd.DataFrame({
'poa_global_pre-adjustment': irrad_pre_adj.poa_global,
'poa_global_post-adjustment': irrad_post_adj.poa_global
})

dni_comparison = pd.DataFrame({
'dni_pre-adjustment': dni,
'dni_post-adjustment': dni_adjusted
})

# Plot results
poa_global_comparison.plot(
title='POA-Global: Before and after Horizon Adjustment',
ylabel='Irradiance'
)
dni_comparison.plot(
title='DNI: Before and after Horizon Adjustment', ylabel='Irradiance'
)
3 changes: 3 additions & 0 deletions docs/sphinx/source/whatsnew/v0.10.2.rst
View file
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,8 @@ Documentation
(:issue:`1724`, :pull:`1838`)
* Update definition of snow events parameter for :py:func:`pvlib.snow.loss_townsend`.
(:issue:`1839`, :pull:`1840`)
* Added gallery example demonstrating how horizon profile data from :py:func:`pvlib.iotools.get_pvgis_horizon`,
can be used to apply horizon shading to time series dni and global poa data. (:pull:`1849`)

Requirements
~~~~~~~~~~~~
Expand All @@ -80,5 +82,6 @@ Contributors
* Anton Driesse (:ghuser:`adriesse`)
* Lukas Grossar (:ghuser:`tongpu`)
* Areeba Turabi (:ghuser:`aturabi`)
* Saurabh Aneja (:ghuser:`spaneja`)
* Miroslav Šedivý (:ghuser:`eumiro`)
* kjsauer (:ghuser:`kjsauer`)

0 comments on commit 9b4317e

Please sign in to comment.