Skip to content

Create ivtools #718

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

Merged
merged 77 commits into from
Sep 11, 2019
Merged

Create ivtools #718

Show file tree
Hide file tree
Changes from 60 commits
Commits
Show all changes
77 commits
Select commit Hold shift + click to select a range
f475120
initial commit fit_cec_using_sam
cwhanse May 3, 2019
7454e4d
outline ivcurves
cwhanse May 3, 2019
9c5e1a9
use nrel-pysam
cwhanse May 6, 2019
593f355
remove sam_dir
cwhanse May 7, 2019
4ab1fed
add Sandia single curve fit
cwhanse May 7, 2019
8a8890f
complete function
cwhanse May 9, 2019
b72b0b4
add test, move code to ivtools.py
cwhanse May 10, 2019
921aea8
remove single files
cwhanse May 10, 2019
4f4ad0f
Merge branch 'master' of https://github.com/pvlib/pvlib-python into i…
cwhanse May 13, 2019
eaee814
change PySCC usage to wrapper
May 14, 2019
d65067b
Merge branch 'master' of https://github.com/pvlib/pvlib-python into i…
May 14, 2019
4744bde
add nrel-pysam to ci/requirements
May 14, 2019
aae2731
stickler, add pysam version in ci/requirements
May 14, 2019
e1697b0
does case matter?
May 14, 2019
e779c7a
remove pysam for py27, move import pysam to try/except
May 14, 2019
b0f0a9d
add requires_scipy
May 14, 2019
df33113
rename variables for style guide
May 14, 2019
bec1915
Merge branch 'master' of https://github.com/pvlib/pvlib-python into i…
May 15, 2019
b64cf57
add test for fit_cec_with_sam
May 18, 2019
c8004ff
fix conflict in requirements
May 18, 2019
586a134
fix typo, raise syntax
May 18, 2019
6d6733d
remove ivtools dir
May 18, 2019
98af4ff
fix pytest fixture usage
cwhanse May 18, 2019
26c8f38
linter, fix np.allclose
cwhanse May 18, 2019
1deb148
relax test condition
cwhanse May 18, 2019
3c66a1d
resolve merge conflict
cwhanse May 24, 2019
8308635
remove try/except, add to docstring, use helper functions
cwhanse May 24, 2019
2601dc5
Merge branch 'master' of https://github.com/pvlib/pvlib-python into i…
cwhanse May 27, 2019
632234e
add requires_pysam
cwhanse May 28, 2019
d975f32
fix import
cwhanse May 28, 2019
37a362d
fix infinite loop
cwhanse May 28, 2019
c956486
update whatsnew, api.rst
cwhanse May 28, 2019
bbd5720
fix lint errors
cwhanse May 28, 2019
01f0dba
lint
cwhanse May 28, 2019
a32bb35
resolve comments
cwhanse Jun 12, 2019
5779b1e
comment response
Jun 18, 2019
0f45925
fix function name in test
Jun 18, 2019
58070da
more comment responses
Jun 20, 2019
9bf7566
add nan output to fit_cec_sam, comment responses
cwhanse Jun 21, 2019
723b454
lint
cwhanse Jun 21, 2019
ad9bc2d
consistent return nan, v_oc arg etc. defaults to None, edit description
cwhanse Jun 24, 2019
6d5ff04
initialize failed
cwhanse Jun 24, 2019
d506140
lint
cwhanse Jun 24, 2019
2517b33
implement exception for failed fitting
cwhanse Jun 25, 2019
320ebf9
remove requirement for sorted i
cwhanse Jun 27, 2019
d66701c
update internal variable name for consistency
cwhanse Jul 12, 2019
fe4bdfe
Merge branch 'ivtools' of https://github.com/cwhanse/pvlib-python int…
cwhanse Jul 12, 2019
6879b36
Merge branch 'master' of https://github.com/pvlib/pvlib-python into i…
cwhanse Jul 12, 2019
0328755
add to __init__.py
cwhanse Jul 16, 2019
cff625b
code style changes
cwhanse Jul 16, 2019
f8a4860
lint
cwhanse Jul 16, 2019
e8be716
adjust error messaging in _calculate_sde_parameters
cwhanse Jul 16, 2019
9af20f7
edits to units in docstring
cwhanse Jul 16, 2019
ee19ed1
change error handling in fit_sde_sandia, docstring reformat
cwhanse Jul 16, 2019
aa47f48
fix tests, docstring edits
cwhanse Jul 16, 2019
e55330f
test math formatting
cwhanse Jul 17, 2019
fb3be8c
more edits to docstring
cwhanse Jul 17, 2019
efe1cfb
multiline raw string
cwhanse Jul 17, 2019
8d68c8c
try another approach
cwhanse Jul 17, 2019
ec6fee5
move r
cwhanse Jul 17, 2019
0270633
change function name, docstring edits
cwhanse Jul 17, 2019
6a3735e
update function name
cwhanse Jul 17, 2019
227d8b5
add math delimiters
cwhanse Jul 17, 2019
16ab69f
remove delimiter, use indent
cwhanse Jul 17, 2019
11b8dda
fix alignment in docstring
cwhanse Jul 17, 2019
f84000d
some edits to docstring format
cwhanse Jul 18, 2019
6cd1095
change name back to sde
cwhanse Jul 23, 2019
dde20b5
add bad IV curves for coverage test
cwhanse Jul 23, 2019
4c39e2a
separate bad IV test, fix test
cwhanse Jul 23, 2019
eab687a
lint
cwhanse Jul 23, 2019
c02a1ab
update api.rst and whatsnew
cwhanse Jul 24, 2019
d6e21b7
Merge branch 'master' of https://github.com/pvlib/pvlib-python into i…
cwhanse Aug 2, 2019
012ef50
merge conflicts
cwhanse Sep 10, 2019
b8a713b
hardwire test output rather than read from old CEC file
cwhanse Sep 10, 2019
3aae45a
test fix
cwhanse Sep 10, 2019
35b90e5
really fix it this time
cwhanse Sep 10, 2019
fe89a87
fix raise statement
cwhanse Sep 10, 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
1 change: 1 addition & 0 deletions ci/requirements-py35.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@ dependencies:
- shapely # pvfactors dependency
- siphon # conda-forge
- pip:
- nrel-pysam
- pvfactors==1.0.1
1 change: 1 addition & 0 deletions ci/requirements-py36.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@ dependencies:
- shapely # pvfactors dependency
- siphon # conda-forge
- pip:
- nrel-pysam
- pvfactors==1.0.1
1 change: 1 addition & 0 deletions ci/requirements-py37.yml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,4 +24,5 @@ dependencies:
- shapely # pvfactors dependency
- siphon # conda-forge
- pip:
- nrel-pysam
- pvfactors==1.0.1
8 changes: 8 additions & 0 deletions docs/sphinx/source/api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -282,6 +282,14 @@ PVsyst model

pvsystem.pvsyst_celltemp

Functions for fitting PV models
-------------------------------
.. autosummary::
:toctree: generated/

ivtools.fit_sde_sandia
ivtools.fit_cec_sam
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Maybe fit_single_diode_cec_sam to more closely mimic the sandia function?

Copy link
Contributor

@markcampanelli markcampanelli Jul 20, 2019 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I kinda like the single-diode equation (SDE) vs. single-diode model (SDM) distinction, and I don’t mind the abbreviations if they are expanded in the docstring. This leads to something succinct and descriptive like:

fit_sde_sandia
fit_sdm_cec_sam

action_thing[_variant]_source

I don’t know if you want to add a variant to the SDE (to cover potential variants, such as with a reverse breakdown component). Also, the variant and source could repeat in some cases, leading to some stuttering.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@markcampanelli good suggestion for naming patterns. There are two different applications here: fitting the SD equation to an IV curve, and fitting a SD model (a set of equations) to some data (in the case of the CEC model and the SAM method, datasheet information). I changed sde to single_diode in one function name, but I don't care for single_diode_equation and single_diode_model in the names.

I'm going to open a new issue to extend the single diode documentation to lay out the terminology: single diode equation, single diode model, 5 parameters vs. model parameters.

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Works for me.


Other
-----

Expand Down
22 changes: 22 additions & 0 deletions docs/sphinx/source/whatsnew/v0.7.0.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,31 @@ Testing
~~~~~~~
* Added 30 minutes to timestamps in `test_psm3.csv` to match change in NSRDB (:issue:`733`)

API Changes
~~~~~~~~~~~


Enhancements
~~~~~~~~~~~~
* Add `ivtools` module to contain functions for IV model fitting.
* Add :py:func:`~pvlib.ivtools.fit_sde_sandia`, a simple method to fit the
single diode equation to an IV curve.
* Add :py:func:`~pvlib.ivtools.fit_cec_sam`, a wrapper to access the
model fitting function '6parsolve' from NREL's System Advisor Model.


Bug fixes
~~~~~~~~~


Testing
~~~~~~~


Contributors
~~~~~~~~~~~~
* Mark Campanellli (:ghuser:`markcampanelli`)
* Will Holmgren (:ghuser:`wholmgren`)
* Cliff Hansen (:ghuser:`cwhanse`)

Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

blank line

* Oscar Dowson (:ghuser:`odow`)
1 change: 1 addition & 0 deletions pvlib/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@
from pvlib import location
from pvlib import solarposition
from pvlib import iotools
from pvlib import ivtools
from pvlib import tracking
from pvlib import pvsystem
from pvlib import spa
Expand Down
Loading