Skip to content

Commit 305c958

Browse files
committed
update readme
1 parent c94da88 commit 305c958

File tree

1 file changed

+37
-15
lines changed

1 file changed

+37
-15
lines changed

README.md

Lines changed: 37 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,43 +6,65 @@ pvlib-python
66
[![Documentation Status](https://readthedocs.org/projects/pvlib-python/badge/?version=latest)](http://pvlib-python.readthedocs.org/en/latest/)
77

88

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/.
9+
pvlib-python is a community supported tool that 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 modeling programs can be found at https://pvpmc.sandia.gov/. We collaborate with the PVLIB-MATLAB project, but operate independently of it.
1010

1111
Documentation
1212
=============
1313

1414
Full documentation can be found at [readthedocs](http://pvlib-python.readthedocs.org/en/latest/).
1515

16-
Development
17-
===========
1816

19-
We need your help to make pvlib-python a great tool! Please see the [Development information wiki](https://github.com/pvlib/pvlib-python/wiki/Development-information) for more on how you can contribute.
17+
Contributing
18+
============
19+
20+
We need your help to make pvlib-python a great tool! Please see the [Development information wiki](https://github.com/pvlib/pvlib-python/wiki/Development-information) for more on how you can contribute. The long-term success of pvlib-python requires community support.
2021

21-
Quick Start
22-
===========
2322

2423
Installation
25-
------------
24+
============
25+
26+
If you have Python
27+
------------------
2628
To obtain the most recent stable release, just use ``pip``:
2729

2830
```
2931
pip install pvlib-python
3032
```
3133

32-
We strongly recommend working in a *virtual environment* (see the wiki or Google for more information). To install the latest development versions, run
3334

34-
```
35-
pip install git+https://github.com/pvlib/pvlib-python.git
36-
```
35+
If you don't have Python
36+
------------------------
37+
The Anaconda Python distribution provides an easy way for new users to get started. Here's the short version:
3738

38-
Alternatively, ``git clone`` this repository, ``cd`` into it, and run
39+
1. Install the full Anaconda Python distribution available [here](). Anaconda includes all of the libraries that you'll need, including ``pandas``, ``numpy``, and ``scipy``.
40+
2. Create a new ``conda`` environment for pvlib: ``conda create -n pvlib``
41+
2. Activate the new environment: ``source activate pvlib``
42+
2. Install pvlib: ``pip install pvlib-python``
43+
44+
You're now ready to start some version of the Python interpreter and use pvlib. The easiest way to start is with one of our IPython notebook tutorials:
45+
46+
1. Use the nbviewer website to choose a tutorial to experiment with. Go to [](), click on e.g. Tutorial.ipynb, and then click on the download symbol.
47+
1. Start the IPython notebook: ``ipython notebook``. This should open a web browser with a file/folder listing. If not, navigate to ``http://localhost:8000``
48+
2. In IPython Notebook, navigate to the file that you downloaded in step one and open it.
49+
2. Use ``shift-enter`` to execute the notebook cell-by-cell. There is also a Play button that will execute all of the cells in the notebook.
50+
51+
Many good online resources exist for getting started with scientific Python. The [pandas tutorial]() is particularly good.
52+
53+
54+
Working at the bleeding-edge
55+
----------------------------
56+
We strongly recommend working in a ``conda`` or ``virtualenv`` *virtual environment* (see the wiki or Google for more information).
57+
To install the very latest development versions, activate your new virtual environment, then run
3958

4059
```
41-
pip install .
60+
pip install git+https://github.com/pvlib/pvlib-python.git
4261
```
4362

44-
Add ``-e`` to install in [develop mode](http://pip.readthedocs.org/en/latest/reference/pip_install.html#editable-installs).
4563

64+
NREL SPA algorithm
65+
------------------
66+
pvlib-python is distributed with several validated, high-precision, and high-performance solar position calculators.
67+
It also includes wrappers for the official NREL SPA algorithm.
4668
To use the NREL SPA algorithm, a pip install from the web cannot be used. Instead:
4769

4870
1. Download the pvlib repository from https://github.com/pvlib/pvlib-python.git
@@ -52,7 +74,7 @@ To use the NREL SPA algorithm, a pip install from the web cannot be used. Instea
5274

5375

5476
Usage Example
55-
-------------
77+
=============
5678
```
5779
# built-in imports
5880
import sys

0 commit comments

Comments
 (0)