Skip to content

Commit 7d6dada

Browse files
HeliolyticsHeliolytics
committed
Update Readme for new repo
1 parent 0fc0820 commit 7d6dada

File tree

1 file changed

+49
-59
lines changed

1 file changed

+49
-59
lines changed

‎README.md

+49-59
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,12 @@
1-
PVLIB_Python
1+
pvlib-python
22
============
33

4-
[![TravisCI](https://travis-ci.org/UARENForecasting/PVLIB_Python.svg)](https://travis-ci.org/UARENForecasting/PVLIB_Python)
5-
[![Coverage Status](https://img.shields.io/coveralls/UARENForecasting/PVLIB_Python.svg)](https://coveralls.io/r/UARENForecasting/PVLIB_Python)
6-
[![Documentation Status](https://readthedocs.org/projects/uarenforecasting-pvlib-python/badge/?version=latest)](http://uarenforecasting-pvlib-python.readthedocs.org/en/latest/)
4+
[![TravisCI](https://travis-ci.org/pvlib/pvlib-python.svg?branch=master)](https://travis-ci.org/pvlib/pvlib-python)
5+
[![Coverage Status](https://img.shields.io/coveralls/pvlib/pvlib-python.svg)](https://coveralls.io/r/pvlib/pvlib-python)
6+
[![Documentation Status](https://readthedocs.org/projects/pvlib-python/badge/?version=latest)](http://pvlib-python.readthedocs.org/en/latest/)
77

8-
This repo is a fork of the [Sandia PVLIB_Python](https://github.com/Sandia-Labs/PVLIB_Python) project.
98

10-
It provides a set of documented functions for simulating the performance of photovoltaic energy systems. The toolbox was originally developed in MATLAB at Sandia National Laboratories and it implements many of the models and methods developed at the Labs.
11-
12-
We make some contributions to the Sandia develop branch, and we pull some commits back into our fork. We hope that Sandia's PVLIB_Python becomes the community standard, but we had some different ideas about how things should be done and we needed to make progress faster than the collaborative cycle would allow. See below for a partial list of differences.
13-
14-
We use this library to generate solar power forecasts for TEP, APS, and other SVERI utilities, and to perform grid integration and variability studies for SVERI. For more information, see [https://forecasting.uaren.org](https://forecasting.uaren.org) and [https://sveri.uaren.org](https://sveri.uaren.org).
15-
16-
The primary drawback to using this library over the official library is that, well, it's not the official Sandia library. Another drawback is that the structure of this library will look a lot different to people coming from the MATLAB world, which is either a good thing or a bad thing depending on your perspective.
17-
18-
Keep the following in mind as you consider using or contributing our fork:
19-
20-
* We hope to keep the projects as similar as possible to make it easier for people to experiment with our fork.
21-
* The Sandia repo should be the default repo for the user community.
22-
* Developers should strongly consider contributing to the official Sandia repo rather than, or in addition to, our fork.
23-
* Reread the above point (...waiting...) before the following (...waiting again...): community contributions in the form of PRs, issues, wikis, docs, tutorials, thoughts, etc are all welcomed and we will try hard to address them in a timely manner.
24-
* All code contributions must be documented, tested, PEP8 compliant, and python 3 compatible. Pythonic code is easier to use, easier to maintain, and faster to develop. Adhering to PEP8 guidelines allows other python developers read code more quickly and accurately.
25-
26-
That being said, we welcome your thoughts and contributions to our fork.
27-
28-
29-
Code differences
30-
================
31-
Here are some of the major differences between our fork and the Sandia PVLIB\_Python project. Note that some of these differences have been resolved in the Sandia [develop branch](https://github.com/Sandia-Labs/PVLIB_Python/tree/develop). We have not attempted to catalog the differences with the MATLAB code.
32-
33-
Library wide changes:
34-
* Remove ``pvl_`` from module names.
35-
* Consolidation of similar modules. For example, functions from ``pvl_clearsky_ineichen.py`` and ``pvl_clearsky_haurwitz.py`` have been consolidated into ``clearsky.py``.
36-
* Removed ``Vars=Locals(); Expect...; var=pvl\_tools.Parse(Vars,Expect);`` pattern. Very few tests of input validitity remain. Garbage in, garbage or ``nan`` out.
37-
* Removing unnecssary and sometimes undesired behavior such as setting maximum zenith=90 or airmass=0. Instead, we make extensive use of ``nan`` values.
38-
* Adding logging calls, removing print calls.
39-
* Code in reviewed modules is mostly PEP8 compliant.
40-
* All code is Python 3 compatible (see testing).
41-
* Changing function and module names so that they do not conflict.
42-
* Added ``/pvlib/data`` for lookup tables, test, and tutorial data.
43-
* Return one DataFrame instead of a tuple of DataFrames.
44-
45-
More specific changes:
46-
* Add PyEphem option to solar position calculations.
47-
* ``irradiance.py`` has more AOI, projection, and irradiance sum and calculation functions
48-
* TMY data is not forced to 1987.
49-
* Locations are now ``pvlib.location.Location`` objects, not structs.
50-
* 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.
51-
* ``clearsky.ineichen`` supports interpolating monthly Linke Turbidities to daily resolution.
52-
53-
Documentation:
54-
* Using readthedocs for documentation hosting.
55-
* Many typos and formatting errors corrected.
56-
* Documentation source code and tutorials live in ``/`` rather than ``/pvlib/docs``.
57-
* Additional tutorials in ``/docs/tutorials``.
58-
59-
Testing:
60-
* Tests are cleaner and more thorough. They are still no where near complete.
61-
* Using Coveralls to measure test coverage.
62-
* Using TravisCI for automated testing.
63-
* Using ``nosetests`` for more concise test code.
9+
pvlib-python provides a set of documented functions for simulating the performance of photovoltaic energy systems. The toolbox was originally developed in MATLAB at Sandia National Laboratories and it implements many of the models and methods developed at the Labs. More information on Sandia Labs PV performance modelling programs can be found at https://pvpmc.sandia.gov/.
6410

6511

6612
Quick Start
@@ -126,3 +72,47 @@ First, make sure the package is installed in develop mode or run ``python setup.
12672
nosetests -v pvlib
12773
```
12874
Unit test code should be placed in the ``pvlib/test`` directory. Each module should have its own test module.
75+
76+
77+
Compatibility
78+
=============
79+
80+
PV_LIB is currently compatible with python 2.7.X, 3.3 and 3.4
81+
82+
83+
Code Transition
84+
================
85+
Here are some of the major differences between the latest build and the original Sandia PVLIB\_Python project.
86+
87+
Library wide changes:
88+
* Remove ``pvl_`` from module names.
89+
* Consolidation of similar modules. For example, functions from ``pvl_clearsky_ineichen.py`` and ``pvl_clearsky_haurwitz.py`` have been consolidated into ``clearsky.py``.
90+
* Removed ``Vars=Locals(); Expect...; var=pvl\_tools.Parse(Vars,Expect);`` pattern. Very few tests of input validitity remain. Garbage in, garbage or ``nan`` out.
91+
* Removing unnecssary and sometimes undesired behavior such as setting maximum zenith=90 or airmass=0. Instead, we make extensive use of ``nan`` values.
92+
* Adding logging calls, removing print calls.
93+
* Code in reviewed modules is mostly PEP8 compliant.
94+
* All code is Python 3 compatible (see testing).
95+
* Changing function and module names so that they do not conflict.
96+
* Added ``/pvlib/data`` for lookup tables, test, and tutorial data.
97+
* Return one DataFrame instead of a tuple of DataFrames.
98+
99+
More specific changes:
100+
* Add PyEphem option to solar position calculations.
101+
* ``irradiance.py`` has more AOI, projection, and irradiance sum and calculation functions
102+
* TMY data is not forced to 1987.
103+
* Locations are now ``pvlib.location.Location`` objects, not structs.
104+
* 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.
105+
* ``clearsky.ineichen`` supports interpolating monthly Linke Turbidities to daily resolution.
106+
107+
Documentation:
108+
* Using readthedocs for documentation hosting.
109+
* Many typos and formatting errors corrected.
110+
* Documentation source code and tutorials live in ``/`` rather than ``/pvlib/docs``.
111+
* Additional tutorials in ``/docs/tutorials``.
112+
113+
Testing:
114+
* Tests are cleaner and more thorough. They are still no where near complete.
115+
* Using Coveralls to measure test coverage.
116+
* Using TravisCI for automated testing.
117+
* Using ``nosetests`` for more concise test code.
118+
*

0 commit comments

Comments
 (0)