Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Fix/issue 205 #207

Merged
merged 16 commits into from
Oct 8, 2020
Merged

Fix/issue 205 #207

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
16 commits
Select commit Hold shift + click to select a range
9f50278
Clean up debugging cell in notebook
mdeceglie Oct 5, 2020
fd4e5c5
Update annual_soiling_ratios
mdeceglie Oct 5, 2020
36e90b0
Run example notebook with new calculation
mdeceglie Oct 5, 2020
e9b5342
Update tests
mdeceglie Oct 5, 2020
64d8ebb
update changelog
mdeceglie Oct 5, 2020
a0817cc
pin nbconvert version
mdeceglie Oct 5, 2020
02313dd
consolidate changelog entries
mdeceglie Oct 6, 2020
6467e2a
adjust docstring
mdeceglie Oct 6, 2020
45126bb
typo
mdeceglie Oct 6, 2020
ad60ce6
Handle overlap between insolation and soiling profiles
mdeceglie Oct 6, 2020
e9fc48e
fix typos
mdeceglie Oct 6, 2020
3a6bd1e
ensure insolation sum is correct in normalization for monte carlo
mdeceglie Oct 6, 2020
bec1b87
bump nbsphinx version
mdeceglie Oct 6, 2020
7a1af7f
Run notebooks
mdeceglie Oct 6, 2020
5c5c8c3
get rid of print statements
mdeceglie Oct 7, 2020
58bc12a
Explicitly test warning message
mdeceglie Oct 7, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
116 changes: 43 additions & 73 deletions docs/degradation_and_soiling_example_pvdaq_4.ipynb
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -616,37 +616,6 @@
"cell_type": "code",
"execution_count": 17,
"metadata": {},
"outputs": [
{
"data": {
"text/plain": [
"0 2010-02-25 00:00:00-07:00\n",
"1 2010-03-08 00:00:00-07:00\n",
"2 2010-03-12 00:00:00-07:00\n",
"3 2010-04-09 00:00:00-07:00\n",
"4 2010-04-12 00:00:00-07:00\n",
" ... \n",
"59 2016-04-10 00:00:00-07:00\n",
"60 2016-04-16 00:00:00-07:00\n",
"61 2016-05-04 00:00:00-07:00\n",
"62 2016-07-13 00:00:00-07:00\n",
"63 2016-12-06 00:00:00-07:00\n",
"Name: start, Length: 64, dtype: datetime64[ns, Etc/GMT+7]"
]
},
"execution_count": 17,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"soiling_summary['start']"
mdeceglie marked this conversation as resolved.
Show resolved Hide resolved
]
},
{
"cell_type": "code",
"execution_count": 18,
"metadata": {},
"outputs": [
{
"data": {
Expand All @@ -673,7 +642,7 @@
},
{
"cell_type": "code",
"execution_count": 19,
"execution_count": 18,
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -835,7 +804,7 @@
"11 6 "
]
},
"execution_count": 19,
"execution_count": 18,
"metadata": {},
"output_type": "execute_result"
}
Expand All @@ -848,7 +817,7 @@
},
{
"cell_type": "code",
"execution_count": 20,
"execution_count": 19,
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -882,81 +851,82 @@
" <tr>\n",
" <th>0</th>\n",
" <td>2010</td>\n",
" <td>0.975022</td>\n",
" <td>0.934111</td>\n",
" <td>0.992382</td>\n",
" <td>0.892087</td>\n",
" <td>0.881133</td>\n",
" <td>0.899309</td>\n",
" </tr>\n",
" <tr>\n",
" <th>1</th>\n",
" <td>2011</td>\n",
" <td>0.958594</td>\n",
" <td>0.872132</td>\n",
" <td>0.984363</td>\n",
" <td>0.944819</td>\n",
" <td>0.936342</td>\n",
" <td>0.950665</td>\n",
" </tr>\n",
" <tr>\n",
" <th>2</th>\n",
" <td>2012</td>\n",
" <td>0.945495</td>\n",
" <td>0.867414</td>\n",
" <td>0.989819</td>\n",
" <td>0.939456</td>\n",
" <td>0.931768</td>\n",
" <td>0.945988</td>\n",
" </tr>\n",
" <tr>\n",
" <th>3</th>\n",
" <td>2013</td>\n",
" <td>0.957287</td>\n",
" <td>0.906841</td>\n",
" <td>0.987823</td>\n",
" <td>0.954258</td>\n",
" <td>0.944068</td>\n",
" <td>0.961534</td>\n",
" </tr>\n",
" <tr>\n",
" <th>4</th>\n",
" <td>2014</td>\n",
" <td>0.959787</td>\n",
" <td>0.902334</td>\n",
" <td>0.991943</td>\n",
" <td>0.950645</td>\n",
" <td>0.929716</td>\n",
" <td>0.966537</td>\n",
" </tr>\n",
" <tr>\n",
" <th>5</th>\n",
" <td>2015</td>\n",
" <td>0.959014</td>\n",
" <td>0.899179</td>\n",
" <td>0.985713</td>\n",
" <td>0.951059</td>\n",
" <td>0.921407</td>\n",
" <td>0.966395</td>\n",
" </tr>\n",
" <tr>\n",
" <th>6</th>\n",
" <td>2016</td>\n",
" <td>0.964605</td>\n",
" <td>0.842394</td>\n",
" <td>0.987011</td>\n",
" <td>0.923150</td>\n",
" <td>0.911463</td>\n",
" <td>0.930717</td>\n",
" </tr>\n",
" </tbody>\n",
"</table>\n",
"</div>"
],
"text/plain": [
" year soiling_ratio_median soiling_ratio_low soiling_ratio_high\n",
"0 2010 0.975022 0.934111 0.992382\n",
"1 2011 0.958594 0.872132 0.984363\n",
"2 2012 0.945495 0.867414 0.989819\n",
"3 2013 0.957287 0.906841 0.987823\n",
"4 2014 0.959787 0.902334 0.991943\n",
"5 2015 0.959014 0.899179 0.985713\n",
"6 2016 0.964605 0.842394 0.987011"
"0 2010 0.892087 0.881133 0.899309\n",
"1 2011 0.944819 0.936342 0.950665\n",
"2 2012 0.939456 0.931768 0.945988\n",
"3 2013 0.954258 0.944068 0.961534\n",
"4 2014 0.950645 0.929716 0.966537\n",
"5 2015 0.951059 0.921407 0.966395\n",
"6 2016 0.923150 0.911463 0.930717"
]
},
"execution_count": 20,
"execution_count": 19,
"metadata": {},
"output_type": "execute_result"
}
],
"source": [
"# Calculate and view annual soiling ratios and their confidence intervals\n",
"# based on the Monte Carlo simulation. Note that these losses include the\n",
"# Calculate and view annual insolation-weighted soiling ratios and their confidence\n",
"# intervals based on the Monte Carlo simulation. Note that these losses include the\n",
"# assumptions of the cleaning assumptions associated with the method parameter\n",
"# of rdtools.soiling_srr(). For anything but 'perfect_clean', each year's soiling\n",
"# ratio may be impacted by prior years' soiling profiles. The default behavior of\n",
"# rdtools.soiling_srr uses method='half_norm_clean'\n",
"\n",
"rdtools.annual_soiling_ratios(soiling_info['stochastic_soiling_profiles'],\n",
" daily_insolation,\n",
" confidence_level=cl)"
]
},
Expand Down Expand Up @@ -985,7 +955,7 @@
},
{
"cell_type": "code",
"execution_count": 21,
"execution_count": 20,
"metadata": {},
"outputs": [],
"source": [
Expand Down Expand Up @@ -1018,7 +988,7 @@
},
{
"cell_type": "code",
"execution_count": 22,
"execution_count": 21,
"metadata": {},
"outputs": [],
"source": [
Expand Down Expand Up @@ -1049,7 +1019,7 @@
},
{
"cell_type": "code",
"execution_count": 23,
"execution_count": 22,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -1075,7 +1045,7 @@
},
{
"cell_type": "code",
"execution_count": 24,
"execution_count": 23,
"metadata": {},
"outputs": [],
"source": [
Expand All @@ -1093,7 +1063,7 @@
},
{
"cell_type": "code",
"execution_count": 25,
"execution_count": 24,
"metadata": {},
"outputs": [
{
Expand Down Expand Up @@ -1140,7 +1110,7 @@
},
{
"cell_type": "code",
"execution_count": 26,
"execution_count": 25,
"metadata": {},
"outputs": [
{
Expand All @@ -1150,7 +1120,7 @@
"<Figure size 720x216 with 2 Axes>"
]
},
"execution_count": 26,
"execution_count": 25,
"metadata": {},
"output_type": "execute_result"
}
Expand Down Expand Up @@ -1178,7 +1148,7 @@
"name": "python",
"nbconvert_exporter": "python",
"pygments_lexer": "ipython3",
"version": "3.7.4"
"version": "3.7.7"
}
},
"nbformat": 4,
Expand Down
1 change: 1 addition & 0 deletions docs/sphinx/source/changelog/pending.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ API Changes
-----------

* Change the column names 'slope', 'slope_low', and 'slope_high' to 'soiling_rate', 'soiling_rate_low', and 'soiling_rate_high' in ``calc_info['soiling_interval_summary']`` returned from :py:meth:`~rdtools.soiling.SRRAnalysis.run()` and :py:func:`rdtools.soiling.soiling_srr()` (:pull:`193`).
* Change the calculations in :py:func:`rdtools.soiling.annual_soiling_raatios()` to perform irradiance-weighting (:issue:`205` :pull:`207`)
mdeceglie marked this conversation as resolved.
Show resolved Hide resolved


Enhancements
Expand Down
24 changes: 17 additions & 7 deletions rdtools/soiling.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -778,7 +778,7 @@ def _count_month_days(start, end):
return out_dict


def annual_soiling_ratios(stochastic_soiling_profiles, confidence_level=68.2):
def annual_soiling_ratios(stochastic_soiling_profiles, insolation_daily, confidence_level=68.2):
'''
Return annualized soiling ratios and associated confidence intervals based
on stochastic soiling profiles from SRR. Note that each year may be affected
Expand All @@ -791,7 +791,9 @@ def annual_soiling_ratios(stochastic_soiling_profiles, confidence_level=68.2):
List of pd.Series representing profile realizations from the SRR monte carlo.
Typically ``soiling_interval_summary['stochastic_soiling_profiles']`` obtained with
:py:func:`rdtools.soiling.soiling_srr` or :py:meth:`rdtools.soiling.SRRAnalysis.run`

insolation_daily : pd.Series
Daily plane-of-array insolation corresponding to
`energy_normalized_daily`. Arbitrary units.
mdeceglie marked this conversation as resolved.
Show resolved Hide resolved
confidence_level : float, default 68.2
The size of the confidence interval to use in determining the upper and lower
quantiles reported in the returned DataFrame. (The median is always included in
Expand Down Expand Up @@ -820,12 +822,20 @@ def annual_soiling_ratios(stochastic_soiling_profiles, confidence_level=68.2):
+------------------------+-------------------------------------------+
'''

all_profiles = pd.concat(stochastic_soiling_profiles)
annual_groups = all_profiles.groupby(all_profiles.index.year)
# Create a df with each realization as a column
all_profiles = pd.concat(stochastic_soiling_profiles, axis=1)
# Weight each day by insolation
all_profiles_weighted = all_profiles.multiply(insolation_daily, axis=0)

# Compute the insolation-weighted soiling ration (IWSR) for each realization
mdeceglie marked this conversation as resolved.
Show resolved Hide resolved
annual_insolation = insolation_daily.groupby(insolation_daily.index.year).sum()
mdeceglie marked this conversation as resolved.
Show resolved Hide resolved
all_annual_weighted_sums = all_profiles_weighted.groupby(all_profiles_weighted.index.year).sum()
all_annual_iwsr = all_annual_weighted_sums.multiply(1/annual_insolation, axis=0)

annual_soiling = pd.DataFrame({
'soiling_ratio_median': annual_groups.quantile(0.5),
'soiling_ratio_low': annual_groups.quantile(0.5 - confidence_level/2/100),
'soiling_ratio_high': annual_groups.quantile(0.5 + confidence_level/2/100),
'soiling_ratio_median': all_annual_iwsr.quantile(0.5, axis=1),
'soiling_ratio_low': all_annual_iwsr.quantile(0.5 - confidence_level/2/100, axis=1),
'soiling_ratio_high': all_annual_iwsr.quantile(0.5 + confidence_level/2/100, axis=1),
})
annual_soiling.index.name = 'year'
annual_soiling = annual_soiling.reset_index()
Expand Down
25 changes: 15 additions & 10 deletions rdtools/test/soiling_test.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -234,34 +234,39 @@ def test_soiling_srr_with_nan_interval(normalized_daily, insolation, times):


@pytest.fixture()
def srr_profiles():
def multi_year_profiles():
times = pd.date_range('01-01-2018', '12-31-2019', freq='D')
data = np.array([0]*365 + [10]*365)
profiles = [pd.Series(x + data, times) for x in range(10)]

return profiles
insolation = 350*[0.8] + (len(times)-350)*[1]
insolation = pd.Series(insolation, index=times)

return profiles, insolation

def test_annual_soiling_ratios(srr_profiles):
expected_data = np.array([[2018, 4.5, 1.0, 8.0],
[2019, 14.5, 11.0, 18.0]])

def test_annual_soiling_ratios(multi_year_profiles):
expected_data = np.array([[2018, 4.5, 1.431, 7.569],
[2019, 14.5, 11.431, 17.569]])
expected = pd.DataFrame(data=expected_data,
columns=['year', 'soiling_ratio_median', 'soiling_ratio_low', 'soiling_ratio_high'])
expected['year'] = expected['year'].astype(int)

result = annual_soiling_ratios(srr_profiles)
srr_profiles, insolation = multi_year_profiles
result = annual_soiling_ratios(srr_profiles, insolation)

pd.testing.assert_frame_equal(result, expected, atol=1e-8)


def test_annual_soiling_ratios_confidence_interval(srr_profiles):
expected_data = np.array([[2018, 4.5, 0, 9.0],
[2019, 14.5, 10.0, 19.0]])
def test_annual_soiling_ratios_confidence_interval(multi_year_profiles):
expected_data = np.array([[2018, 4.5, 0.225, 8.775],
[2019, 14.5, 10.225, 18.775]])
expected = pd.DataFrame(data=expected_data,
columns=['year', 'soiling_ratio_median', 'soiling_ratio_low', 'soiling_ratio_high'])
expected['year'] = expected['year'].astype(int)

result = annual_soiling_ratios(srr_profiles, confidence_level=95)
srr_profiles, insolation = multi_year_profiles
result = annual_soiling_ratios(srr_profiles, insolation, confidence_level=95)

pd.testing.assert_frame_equal(result, expected, atol=1e-8)

Expand Down
2 changes: 2 additions & 0 deletions setup.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -54,6 +54,8 @@
'pvlib==0.7.1',
'sphinx_rtd_theme==0.4.3',
'ipython',
'nbconvert==6.0.6'
mdeceglie marked this conversation as resolved.
Show resolved Hide resolved

],
'test': [
'pytest',
Expand Down