Skip to content

Create iam.py, consistent naming for IAM functions #783

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.

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

Merged
merged 35 commits into from
Oct 18, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
35 commits
Select commit Hold shift + click to select a range
73f4638
move iam functions to iam.py
cwhanse Oct 2, 2019
a89cc01
move function tests to test_iam.py
cwhanse Oct 2, 2019
0f1c90c
adjust PVSystem methods, add deprecation for functions and PVSystem m…
cwhanse Oct 2, 2019
0a55b54
adjust PVSystem tests, test for function deprecation
cwhanse Oct 2, 2019
8505a0d
move sapm aoi function, adjust ModelChain methods
cwhanse Oct 2, 2019
f48742c
remove _ typo
cwhanse Oct 2, 2019
1bcde31
lint fixes
cwhanse Oct 2, 2019
c51bc08
move fixture to correct place
cwhanse Oct 2, 2019
5e01712
move sapm_module_params fixture to conftest.py
cwhanse Oct 2, 2019
e5bebe1
fix cut/paste errors
cwhanse Oct 3, 2019
549fc2c
add missing keys to fixture, add missing text to pvsystem.sapm docstring
cwhanse Oct 3, 2019
42210e4
fix and update pvsystem.sapm tests
cwhanse Oct 3, 2019
1475db6
remove DataFrame test for sapm, lint fixes
cwhanse Oct 3, 2019
006768d
implement PVSystem.get_iam, add deprecation test for pvsystem.sapm_ao…
cwhanse Oct 3, 2019
c10af4c
lint
cwhanse Oct 3, 2019
b9e39ac
Merge branch 'master' into iam
cwhanse Oct 3, 2019
ab1fbbc
test fixes, add Material to sapm_module_params fixture
cwhanse Oct 3, 2019
4dadd4b
test fixes
cwhanse Oct 4, 2019
7f14c95
add martin_ruiz to modelchain
cwhanse Oct 4, 2019
9164592
finish adding martin_ruiz to modelchain
cwhanse Oct 4, 2019
2fe7396
add test for ModelChain.infer_aoi_model, improve coverage
cwhanse Oct 4, 2019
3d6bcf5
repair delete mistake
cwhanse Oct 4, 2019
64a6b3c
test for invalid aoi model parameters in ModelChain
cwhanse Oct 4, 2019
152ef7a
update api, whatsnew
cwhanse Oct 4, 2019
46db9d7
test fix
cwhanse Oct 4, 2019
ea6fe81
fixture for aoi_model tests
cwhanse Oct 4, 2019
2529351
bad indent
cwhanse Oct 4, 2019
f641cd0
docstring and lint
cwhanse Oct 4, 2019
f331949
lint
cwhanse Oct 4, 2019
ec723c6
module docstring, changes to tests
cwhanse Oct 15, 2019
cf998ea
test fixes
cwhanse Oct 15, 2019
23f2677
another test fix
cwhanse Oct 16, 2019
1e63f04
improve coverage
cwhanse Oct 16, 2019
5fb7cc8
fix exception test
cwhanse Oct 16, 2019
b43b28c
fix the fix
cwhanse Oct 16, 2019
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
12 changes: 7 additions & 5 deletions docs/sphinx/source/api.rst
Original file line number Diff line number Diff line change
Expand Up @@ -211,15 +211,17 @@ wrap the functions listed below. See its documentation for details.
pvsystem.PVSystem
pvsystem.LocalizedPVSystem

AOI modifiers
-------------
Incident angle modifiers
------------------------

.. autosummary::
:toctree: generated/

pvsystem.physicaliam
pvsystem.ashraeiam
pvsystem.sapm_aoi_loss
iam.physical
iam.ashrae
iam.martin_ruiz
iam.sapm
iam.interp

PV temperature models
---------------------
Expand Down
27 changes: 20 additions & 7 deletions docs/sphinx/source/whatsnew/v0.7.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,20 @@ API Changes
- `modelchain.basic_chain` has a new required argument
`temperature_model_parameters`.

* Changes related to IAM (AOI loss) functions (:issue:`680`):
* Changes to functions
- Moved functions from `pvsystem.py` to `iam.py`. `pvsystem` IAM
functions are deprecated and will be removed in v0.8.
- Functions are renamed to a consistent pattern:
- `pvsystem.physicaliam` is `iam.physical`
- `pvsystem.ashraeiam` is `iam.ashrae`
- `pvsystem.sapm_aoi_loss` is `iam.sapm`
- Created dict `iam.IAM_MODEL_PARAMS` to aid in identifying IAM models
* Changes to `PVSystem` class
- IAM models are provided by `PVSystem.get_iam` with kwarg `iam_model`.
- Methods `PVSystem.ashraeiam`, `PVSystem.physicaliam` and
`PVSystem.sapm_aoi_loss` are deprecated and will be removed in v0.8.

* Calling :py:func:`pvlib.pvsystem.retrieve_sam` with no parameters will raise
an exception instead of displaying a dialog.
* The `times` keyword argument has been deprecated in the
Expand All @@ -83,8 +97,9 @@ API Changes

Enhancements
~~~~~~~~~~~~
* Created two new incidence angle modifier functions: :py:func:`pvlib.pvsystem.iam_martin_ruiz`
and :py:func:`pvlib.pvsystem.iam_interp`. (:issue:`751`)
* Created two new incidence angle modifier (IAM) functions:
:py:func:`pvlib.iam.martin_ruiz` and :py:func:`pvlib.iam.interp`. (:issue:`751`)
* Add the `martin_ruiz` IAM function as an option for `ModelChain.aoi_model`.
* Updated the file for module parameters for the CEC model, from the SAM file
dated 2017-6-5 to the SAM file dated 2019-03-05. (:issue:`761`)
* Updated the file for inverter parameters for the CEC model, from the SAM file
Expand All @@ -96,6 +111,7 @@ Enhancements
the single diode equation to an IV curve.
* Add :py:func:`~pvlib.ivtools.fit_sdm_cec_sam`, a wrapper for the CEC single
diode model fitting function '6parsolve' from NREL's System Advisor Model.
* Add `timeout` to :py:func:`pvlib.iotools.get_psm3`.

Bug fixes
~~~~~~~~~
Expand All @@ -113,6 +129,8 @@ Testing
in NSRDB (:issue:`733`)
* Added tests for methods in bifacial.py.
* Added tests for changes to cell temperature models.
* Added tests for changes to IAM models.
* Added test for `ModelChain.infer_aoi_model`.

Documentation
~~~~~~~~~~~~~
Expand All @@ -132,11 +150,6 @@ Removal of prior version deprecations
* Removed `ModelChain.prepare_inputs` clearsky assumption when no irradiance
data was provided.

Enhancements
~~~~~~~~~~~~
* Add `timeout` to :py:func:`pvlib.iotools.get_psm3`.


Contributors
~~~~~~~~~~~~
* Mark Campanellli (:ghuser:`markcampanelli`)
Expand Down
Loading