Skip to content

Commit 8eccb5e

Browse files
committed
improve whats new and comparison
1 parent fe79359 commit 8eccb5e

File tree

2 files changed

+114
-2
lines changed

2 files changed

+114
-2
lines changed

docs/sphinx/source/comparison_pvlib_matlab.rst

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,44 @@ Please see our
1111
and
1212
`PVSC 2015 abstract <https://github.com/UARENForecasting/pvlib-pvsc2015/blob/master/pvlib_pvsc_42.pdf?raw=true>`_
1313
for more information.
14+
15+
Here are some of the major differences between the latest pvlib-python build
16+
and the original Sandia PVLIB\_Python project, but many of these
17+
comments apply to the difference between pvlib-python and PVLIB\_MATLAB.
18+
19+
20+
Library wide changes
21+
~~~~~~~~~~~~~~~~~~~~
22+
23+
* Remove ``pvl_`` from module names.
24+
* Consolidation of similar modules. For example, functions from ``pvl_clearsky_ineichen.py`` and ``pvl_clearsky_haurwitz.py`` have been consolidated into ``clearsky.py``.
25+
* Removed ``Vars=Locals(); Expect...; var=pvl\_tools.Parse(Vars,Expect);`` pattern. Very few tests of input validitity remain. Garbage in, garbage or ``nan`` out.
26+
* Removing unnecssary and sometimes undesired behavior such as setting maximum zenith=90 or airmass=0. Instead, we make extensive use of ``nan`` values.
27+
* Changing function and module names so that they do not conflict.
28+
* Added ``/pvlib/data`` for lookup tables, test, and tutorial data.
29+
30+
31+
More specific changes
32+
~~~~~~~~~~~~~~~~~~~~~
33+
34+
* Add PyEphem option to solar position calculations.
35+
* ``irradiance.py`` has more AOI, projection, and irradiance sum and calculation functions
36+
* Locations are now ``pvlib.location.Location`` objects, not structs.
37+
* Specify time zones using a string from the standard IANA Time Zone Database naming conventions or using a pytz.timezone instead of an integer GMT offset. We may add dateutils support in the future.
38+
* ``clearsky.ineichen`` supports interpolating monthly Linke Turbidities to daily resolution.
39+
40+
Documentation
41+
~~~~~~~~~~~~~
42+
43+
* Using readthedocs for documentation hosting.
44+
* Many typos and formatting errors corrected.
45+
* Documentation source code and tutorials live in ``/`` rather than ``/pvlib/docs``.
46+
* Additional tutorials in ``/docs/tutorials``.
47+
48+
Testing
49+
~~~~~~~
50+
51+
* Tests are cleaner and more thorough. They are still no where near complete.
52+
* Using Coveralls to measure test coverage.
53+
* Using TravisCI for automated testing.
54+
* Using ``nosetests`` for more concise test code.

docs/sphinx/source/whatsnew/v0.1.0.txt

Lines changed: 73 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,15 +3,86 @@
33
v0.1.0 (March 17, 2015)
44
-----------------------
55

6-
This is the first true release of the pvlib-python project.
7-
As such, this document is a little hard to write.
6+
This is the first official release of the pvlib-python project.
7+
As such, a "What's new" document is a little hard to write.
88
There will be significant overlap with the to-be-written document
99
that describes the differences between pvlib-python and PVLIB\_Matlab.
1010

11+
12+
API changes
13+
~~~~~~~~~~~
14+
15+
* Remove ``pvl_`` from module names.
16+
* Consolidation of similar modules. For example, functions from ``pvl_clearsky_ineichen.py`` and ``pvl_clearsky_haurwitz.py`` have been consolidated into ``clearsky.py``.
17+
* Return one DataFrame instead of a tuple of DataFrames.
18+
* Change function and module names so that they do not conflict.
19+
20+
1121
New features
1222
~~~~~~~~~~~~
1323

24+
* Library is Python 3.3 and 3.4 compatible
25+
* Add What's New section to docs (:issue:`10`)
26+
* Add PyEphem option to solar position calculations.
27+
* ``irradiance.py`` has more AOI, projection, and irradiance sum and calculation functions
28+
* TMY data import has a ``coerce_year`` option
29+
* TMY data can be loaded from a url (:issue:`5`)
30+
* Locations are now ``pvlib.location.Location`` objects, not "structs".
31+
* Specify time zones using a string from the standard IANA Time Zone Database naming conventions or using a pytz.timezone instead of an integer GMT offset. We may add dateutils support in the future.
32+
* ``clearsky.ineichen`` supports interpolating monthly Linke Turbidities to daily resolution.
33+
34+
35+
Other changes
36+
~~~~~~~~~~~~~
37+
38+
* Removed ``Vars=Locals(); Expect...; var=pvl\_tools.Parse(Vars,Expect);`` pattern. Very few tests of input validitity remain. Garbage in, garbage or ``nan`` out.
39+
* Removing unnecssary and sometimes undesired behavior such as setting maximum zenith=90 or airmass=0. Instead, we make extensive use of ``nan`` values.
40+
* Adding logging calls, removing print calls.
41+
* Improved PEP8 compliance.
42+
* Added ``/pvlib/data`` for lookup tables, test, and tutorial data.
43+
44+
45+
Documentation
46+
~~~~~~~~~~~~~
47+
48+
* Using readthedocs for documentation hosting.
49+
* Many typos and formatting errors corrected (:issue:`16`)
50+
* Documentation source code and tutorials live in ``/`` rather than ``/pvlib/docs``.
51+
* Additional tutorials in ``/docs/tutorials``.
52+
* Clarify ``pvsystem.systemdef`` input (:issue:`17`)
53+
54+
55+
Testing
56+
~~~~~~~
57+
58+
* Tests are cleaner and more thorough. They are still no where near complete.
59+
* Using Coveralls to measure test coverage.
60+
* Using TravisCI for automated testing.
61+
* Using ``nosetests`` for more concise test code.
1462

1563

1664
Bug fixes
1765
~~~~~~~~~
66+
67+
* TODO: Fix DISC algorithm conditional evaluation (:issue:`6`)
68+
* TODO: Prevent DISC algorithm from modifying input zenith Series (:issue:`24`)
69+
* Many more bug fixes were made, but you'll have to look at the detailed commit history.
70+
71+
72+
Contributors
73+
~~~~~~~~~~~~
74+
75+
This list includes all (I hope) contributors to
76+
`pvlib/pvlib-python <https://github.com/pvlib/pvlib-python>`_,
77+
`Sandia-Labs/PVLIB_Python <https://github.com/Sandia-Labs/PVLIB_Python>`_,
78+
and
79+
`UARENForecasting/PVLIB_Python <https://github.com/UARENForecasting/PVLIB_Python>`_.
80+
81+
* Rob Andrews
82+
* Will Holmgren
83+
* bmu
84+
* Tony Lorenzo
85+
* jforbess
86+
* Jorissup
87+
* dacoex
88+
* alexisph

0 commit comments

Comments
 (0)