DOC: Discuss Angstrom Kasten TL, set default alpha #563

mikofski · 2018-09-06T09:26:54Z

pvlib python pull request guidelines

Thank you for your contribution to pvlib python! You may delete all of these instructions except for the list below.

You may submit a pull request with your code at any stage of completion.

The following items must be addressed before the code can be merged. Please don't hesitate to ask for help if you're unsure of how to accomplish any of the items below:

Closes add discussion and examples of Angstrom and Kasten formulas to docs #302
I am familiar with the contributing guidelines.
Fully tested. Added and/or modified tests to ensure correct behavior for all reasonable inputs. Tests (usually) must pass on the TravisCI and Appveyor testing services.
Updates entries to docs/sphinx/source/api.rst for API changes.
Adds description and name entries in the appropriate docs/sphinx/source/whatsnew file for all changes.
Code quality and style is sufficient. Passes git diff upstream/master -u -- "*.py" | flake8 --diff
New code is fully documented. Includes sphinx/numpydoc compliant docstrings and comments in the code where necessary.
Pull request is nearly complete and ready for detailed review.

Brief description of the problem and proposed solution (if not already fully described in the issue linked to above):

* closes pvlib#302 * add references to Kasten 96 and Molineaux * discuss using Kasten and calculating broadband AOD usinge Angstrom turbidity model Signed-off-by: Mark Mikofski <[email protected]>

mikofski · 2018-09-06T09:27:52Z

is this okay?

docs/sphinx/source/clearsky.rst

cwhanse · 2018-09-06T14:44:11Z

docs/sphinx/source/clearsky.rst

+
+    In [1]: MBARS = 100  # conversion factor from mbars to Pa
+
+    In [1]: URL = 'http://rredc.nrel.gov/solar/old_data/nsrdb/1991-2005/data/tmy3/722040TYA.CSV'


There is a TMY file in pvlib/data, I think it is safer to use it rather than read from the URL.

docs/sphinx/source/clearsky.rst

mikofski · 2018-09-06T15:10:15Z

Great feedback, thanks. I agree with all comments.

FYI: There are no italics in the IPython example, that's just GitHub not rendering correctly b/c it doesn't understand the .. ipython:: directive, okay?

mikofski · 2018-09-06T15:12:18Z

@wholmgren is there a built version of the docs that I can point reviewers to online?

wholmgren · 2018-09-06T15:17:45Z

is there a built version of the docs that I can point reviewers to online?

You'd need to login to readthedocs.org and configure it to build this particular branch of your fork. It only takes a few minutes to set up the first time.

wholmgren

thanks mark. minor edits suggested.

docs/sphinx/source/clearsky.rst

wholmgren · 2018-09-06T15:21:39Z

docs/sphinx/source/clearsky.rst

+
+.. ipython::
+
+    In [1]: MBARS = 100  # conversion factor from mbars to Pa


I know you have your reasons for using caps here, but I think it's better for most readers to see lower case.

docs/sphinx/source/clearsky.rst

wholmgren · 2018-09-06T15:27:09Z

docs/sphinx/source/clearsky.rst

-Solis model requires AOD at 700 nm. Models exist to convert AOD between
-different wavelengths, as well as convert Linke turbidity to AOD and PW
-[Ine08con]_, [Ine16]_.
+Solis model requires AOD at 700 nm. The function,


delete The function and commas. I think the formatting makes it clear that it's a function. But you can keep it if you prefer this way.

wholmgren · 2018-09-06T15:27:46Z

docs/sphinx/source/clearsky.rst

+Solis model requires AOD at 700 nm. The function,
+:py:func:`~pvlib.atmosphere.angstrom_aod_at_lambda`, is useful for converting
+AOD between different wavelengths using the Angstrom turbidity model and given
+the Angstrom exponent, :math:`\alpha`, which can be calculated from AOD at two


please split this into 2 or more sentences.

wholmgren · 2018-09-06T15:28:21Z

docs/sphinx/source/clearsky.rst

+AOD between different wavelengths using the Angstrom turbidity model and given
+the Angstrom exponent, :math:`\alpha`, which can be calculated from AOD at two
+wavelengths with the :py:func:`~pvlib.atmosphere.angstrom_alpha` function. The
+function, :py:func:`~pvlib.atmosphere.bird_hulstrom80_aod_bb`, can be used to


same comment on "the function" as above

* use TMY in pvlib/data, lowercase MBARS, use non-specific variable names * split output from readtmy3 instead of using indexing for clarity

stickler-ci · 2018-09-06T19:14:39Z

I couldn't find a .stickler.yml file in this repository. I can make one for you, or you can create one by following the documentation.

mikofski · 2018-09-06T19:57:08Z

FYI: rtfd build of my fork is failing and I don't know why

mikofski · 2018-09-06T20:20:15Z

Also there is currently no default for alpha in pvlib.atmosphere.angstrom_aod_at_lambda, but I think we should set it at 1.14 as recommended by NREL SPECTRL2 (see section 2)

When a single value of α is used to represent the rural aerosol model, the value should be α = 1.140.

It's also in the source for the origin FORTRAN code

	C   ALPHA= POWER ON ANGSTRON TURBIDITY EXPRESSION (1.14 FOR RURAL)

And in both spreadsheet implementation and C-headers, see here.

wholmgren · 2018-09-06T20:27:32Z

@mikofski I'm not sure either. I've never seen that error. The common errors I see are intermittent and related to timeouts of one thing or another. I poked around the settings a little bit but nothing jumped out. Sorry.

wholmgren · 2018-09-06T20:28:33Z

Fine with me if you want to make a default alpha. If so, please update whatsnew and the PR title accordingly.

wholmgren

I rendered the documentation and it mostly looks good.

wholmgren · 2018-09-06T21:33:45Z

docs/sphinx/source/clearsky.rst

+       ...:     altitude=tmy_header['altitude'], pressure=tmy_data['Pressure']*mbars,
+       ...:     temperature=tmy_data['DryBulb'])
+
+    In [1]: am_rel = atmosphere.relativeairmass(solpos.apparent_zenith)


get_relative_airmass

wholmgren · 2018-09-06T21:33:54Z

docs/sphinx/source/clearsky.rst

+
+    In [1]: am_rel = atmosphere.relativeairmass(solpos.apparent_zenith)
+
+    In [1]: am_abs = atmosphere.absoluteairmass(am_rel, tmy_data['Pressure']*mbars)


get_absolute_airmass

wholmgren · 2018-09-06T21:34:51Z

docs/sphinx/source/clearsky.rst

+    In [1]: tmy_data, tmy_header = tmy.readtmy3(tmy_file)  # read TMY data
+
+    In [1]: dt = pd.DatetimeIndex(start='1999-01-01 00:00:00', end='1999-12-31 23:59:59',
+       ...:     freq='H')


out of curiosity why do this instead of use the readtmy3 coerce_year kwarg?

wholmgren · 2018-09-06T21:43:25Z

docs/sphinx/source/clearsky.rst

@@ -118,6 +116,66 @@ The Ineichen and Perez clear sky model parameterizes irradiance in terms
 of the Linke turbidity [Ine02]_. pvlib-python implements this model in
 the :py:func:`pvlib.clearsky.ineichen` function.

+
+The :py:func:`~pvlib.atmosphere.kasten96_lt` function can be used to calculate


The "Turbidity data" section below introduces the clearsky.lookup_linke_turbidity function. Your example uses this function, so I think your new text/example should be appended to that section. Am I missing something?

wholmgren · 2018-09-06T21:50:09Z

docs/sphinx/source/clearsky.rst

+
+    In [1]: alpha_exponent = atmosphere.angstrom_alpha(aod1240nm, 1240, aod550nm, 550)
+
+    In [1]: aod700nm = atmosphere.angstrom_aod_at_lambda(aod1240nm, 1240, alpha_exponent, 700)


suggest a line(s) that prints the alpha_exponent and aod700nm

mikofski added 2 commits September 6, 2018 02:00

DOC: add example for Kasten pyrheliometric formula

3ba597e

* closes pvlib#302 * add references to Kasten 96 and Molineaux * discuss using Kasten and calculating broadband AOD usinge Angstrom turbidity model Signed-off-by: Mark Mikofski <[email protected]>

DOC: update what's new, add refs to Bird & Hulstrom and Angstrom

fffab3a

mikofski changed the title ~~Discuss angstrom kasten tl~~ DOC: Discuss angstrom kasten tl Sep 6, 2018

cwhanse reviewed Sep 6, 2018

View reviewed changes

docs/sphinx/source/clearsky.rst Outdated Show resolved Hide resolved

cwhanse reviewed Sep 6, 2018

View reviewed changes

docs/sphinx/source/clearsky.rst Outdated Show resolved Hide resolved

cwhanse reviewed Sep 6, 2018

View reviewed changes

docs/sphinx/source/clearsky.rst Outdated Show resolved Hide resolved

wholmgren added the documentation label Sep 6, 2018

wholmgren added this to the 0.6.0 milestone Sep 6, 2018

wholmgren reviewed Sep 6, 2018

View reviewed changes

mikofski added 2 commits September 6, 2018 11:05

DOC: split sentences, replace abbrev. AOD

e149e3e

* use TMY in pvlib/data, lowercase MBARS, use non-specific variable names * split output from readtmy3 instead of using indexing for clarity

DOC: fix up ipython example

4b93e22

mikofski added 2 commits September 6, 2018 12:54

DOC: split sentences, revise, add angstrom example

8f3004e

Merge branch 'master' into discuss_angstrom_kasten_tl

488cb85

mikofski changed the title ~~DOC: Discuss angstrom kasten tl~~ DOC: Discuss Angstrom Kasten TL, set default alpha Sep 6, 2018

ENH: set default alpha to 1.14, update what's new

daf04c5

wholmgren reviewed Sep 6, 2018

View reviewed changes

mikofski added 3 commits September 6, 2018 15:14

DOC: use coerce year, use v0.6.0 get_property() for airmass

f64f718

DOC: print calculated AOD, move TL calculation after turbidity section

70231ea

DOC: wrap long lines, abbrev AOD, be explicit re: fictitious AOD

04fd379

wholmgren approved these changes Sep 6, 2018

View reviewed changes

wholmgren merged commit ec329e2 into pvlib:master Sep 7, 2018

mikofski deleted the discuss_angstrom_kasten_tl branch September 8, 2018 17:45


		In [1]: MBARS = 100 # conversion factor from mbars to Pa

		In [1]: URL = 'http://rredc.nrel.gov/solar/old_data/nsrdb/1991-2005/data/tmy3/722040TYA.CSV'


		.. ipython::

		In [1]: MBARS = 100 # conversion factor from mbars to Pa


		In [1]: am_rel = atmosphere.relativeairmass(solpos.apparent_zenith)

		In [1]: am_abs = atmosphere.absoluteairmass(am_rel, tmy_data['Pressure']*mbars)


		In [1]: alpha_exponent = atmosphere.angstrom_alpha(aod1240nm, 1240, aod550nm, 550)

		In [1]: aod700nm = atmosphere.angstrom_aod_at_lambda(aod1240nm, 1240, alpha_exponent, 700)

DOC: Discuss Angstrom Kasten TL, set default alpha #563

DOC: Discuss Angstrom Kasten TL, set default alpha #563

Uh oh!

Conversation

mikofski commented Sep 6, 2018 • edited by wholmgren Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

pvlib python pull request guidelines

Uh oh!

mikofski commented Sep 6, 2018

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Uh oh!

mikofski commented Sep 6, 2018

Uh oh!

mikofski commented Sep 6, 2018

Uh oh!

wholmgren commented Sep 6, 2018

Uh oh!

wholmgren left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

stickler-ci bot commented Sep 6, 2018

Uh oh!

mikofski commented Sep 6, 2018

Uh oh!

mikofski commented Sep 6, 2018

Uh oh!

wholmgren commented Sep 6, 2018

Uh oh!

wholmgren commented Sep 6, 2018

Uh oh!

wholmgren left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Uh oh!

mikofski commented Sep 6, 2018 •

edited by wholmgren

Loading