Skip to content

Commit b850108

Browse files
committed
update README to reflect PVLIB_Python name change
1 parent ce57864 commit b850108

File tree

1 file changed

+11
-9
lines changed

1 file changed

+11
-9
lines changed

README.md

+11-9
Original file line numberDiff line numberDiff line change
@@ -1,27 +1,29 @@
1-
pythonic-PVLIB
2-
==============
1+
PVLIB_Python
2+
============
33

4-
pythonic-PVLIB is a fork of the [PVLIB_Python](https://github.com/Sandia-Labs/PVLIB_Python) project.
4+
This repo is a fork of the [Sandia PVLIB_Python](https://github.com/Sandia-Labs/PVLIB_Python) project.
55

66
It provides a set of sometimes-well-documented and usually correct functions for simulating the performance of photovoltaic energy systems. The toolbox was originally developed at Sandia National Laboratories and it implements many of the models and methods developed at the Labs.
77

8-
We make some contributions to the PVLIB\_Python develop branch, and we pull some commits to PVLIB\_Python back into our fork. We hope that the Sandia 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.
8+
We make some contributions to the Sandia develop branch, and we pull some commits back into our fork. We hope that the Sandia 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.
99

10-
We use this library to generate solar power forecasts for TEP, APS, and SVERI utilities, and to perform grid integration and variability studies for SVERI utilities. For more information, see [https://forecasting.uaren.org](https://forecasting.uaren.org) and [https://sveri.uaren.org](https://sveri.uaren.org).
10+
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).
1111

12-
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. Keep the following in mind as you consider using or developing pythonic-PVLIB:
12+
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. Keep the following in mind as you consider using or developing our fork:
1313

14-
* We hope to keep the projects as similar as possible to make it easier for people to experiment with pythonic-PVLIB.
14+
* We hope to keep the projects as similar as possible to make it easier for people to experiment with our fork.
1515
* The Sandia repo should be the default repo for the user community.
16-
* Developers should strongly consider working on the official Sandia repo rather than, or in addition to, pythonic-PVLIB.
16+
* Developers should strongly consider working on the official Sandia repo rather than, or in addition to, our fork.
1717
* 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.
1818
* All code contributions must be documented, PEP8 compliant, and python 3 compatible.
1919
* We're not promising to maintain this repo for any length of time.
2020

21+
That being said, we welcome your thoughts and contributions to our fork.
22+
2123

2224
Code differences
2325
===============
24-
Here are some of the major differences between our fork and PVLIB\_Python. Note that some of these differences have been resolved in the PVLIB\_Python [develop branch](https://github.com/Sandia-Labs/PVLIB_Python/tree/develop).
26+
Here are some of the major differences between our fork and the official project. Note that some of these differences have been resolved in the Sandia [develop branch](https://github.com/Sandia-Labs/PVLIB_Python/tree/develop).
2527

2628
* Remove pvl_ from module names.
2729
* Locations are now ``pvlib.location.Location`` objects, not structs.

0 commit comments

Comments
 (0)