You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+38-24Lines changed: 38 additions & 24 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -8,6 +8,7 @@ pvlib-python
8
8
9
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.
10
10
11
+
11
12
Documentation
12
13
=============
13
14
@@ -17,48 +18,50 @@ Full documentation can be found at [readthedocs](http://pvlib-python.readthedocs
17
18
Contributing
18
19
============
19
20
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.
21
+
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 substantial community support.
21
22
22
23
23
24
Installation
24
25
============
25
26
26
27
If you have Python
27
28
------------------
28
-
To obtain the most recent stable release, just use ``pip``:
29
+
To obtain the most recent stable release, just use ``pip`` or ``conda``:
If your system complains that you don't have access privileges or asks for a password then you're trying to install pvlib into your system's Python distribution. This is a very bad idea and you should instead follow the **If you don't have Python** instructions below.
33
40
34
41
35
42
If you don't have Python
36
43
------------------------
37
-
The Anaconda Python distribution provides an easy way for new users to get started. Here's the short version:
44
+
There are many ways to install Python on your system, but the Anaconda Scientific Python distribution provides by far the easiest way for new users to get started. Anaconda includes all of the popular libraries that you'll need for pvlib, including Pandas, NumPy, and SciPy. "Anaconda installs cleanly into a single directory, does not require Administrator or root privileges, does not affect other Python installs on your system, or interfere with OSX Frameworks." -Anaconda Documentation.
38
45
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``
46
+
1. Install the full Anaconda Scientific Python distribution available [here](https://store.continuum.io/cshop/anaconda/).
43
47
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:
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
+
If you have trouble, see the [Anaconda FAQ](http://docs.continuum.io/anaconda/faq.html), Google your error messages, or make a new issue on our [Issues page](https://github.com/pvlib/pvlib-python/issues).
50
51
51
-
Many good online resources exist for getting started with scientific Python. The [pandas tutorial]() is particularly good.
52
52
53
-
54
-
Working at the bleeding-edge
53
+
Working at the bleeding edge
55
54
----------------------------
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
55
+
We strongly recommend working in a **virtual environment** if you're going to use the development versions of the code. There are many ways to use virtual environments in Python, but Anaconda again provides the easiest solution:
1. Create a new conda environment for pvlib and pre-install a handful of packages into the environment: ``conda create --name pvlibdev python pandas scipy ephem``
58
+
2. Activate the new environment: ``source activate pvlibdev``
59
+
2. Install the latest development version
60
+
A. If you don't plan to modify the source-code: ``pip install git+https://github.com/pvlib/pvlib-python.git``
61
+
B. If you do plan to modify the source code: Use the GitHub GUI application or git command-line tool to clone this repository to your computer, then navigate your command-line to the top-level pvlib-python directory, then ``pip install -e .``
62
+
2. You may also consider installing additional packages into your development environment: ``conda install ipython-notebook nose seaborn``
63
+
64
+
The [conda documentation](http://conda.pydata.org/docs/using/index.html) has more information on how to use virtual environments.
62
65
63
66
64
67
NREL SPA algorithm
@@ -73,8 +76,17 @@ To use the NREL SPA algorithm, a pip install from the web cannot be used. Instea
73
76
4. From the ``pvlib-python`` directory, run ``pip uninstall pvlib`` followed by ``pip install . ``
74
77
75
78
76
-
Usage Example
77
-
=============
79
+
Usage
80
+
=====
81
+
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:
82
+
83
+
1. Use the nbviewer website to choose a tutorial to experiment with. Go to our [nbviewer tutorial page](http://nbviewer.ipython.org/github/pvlib/pvlib-python/tree/master/docs/tutorials/), click on e.g. pvsystem.ipynb, and then click on the download symbol.
84
+
1. Start the IPython Notebook server: ``ipython notebook``. This should open a web browser with the IPython Notebook's file/folder listing. If not, navigate to the url shown in the command line history, likely ``http://localhost:8888``
85
+
2. In IPython Notebook, navigate to the file that you downloaded in step one and open it.
86
+
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.
87
+
88
+
You can also experiment with the following simple code in a new IPython notebook or any other Python interpreter:
89
+
78
90
```
79
91
# built-in imports
80
92
import sys
@@ -95,14 +107,16 @@ tus = Location(32.2, -111, 'MST', 700)
95
107
times = pd.date_range(start=datetime.datetime(2014,6,24), end=datetime.datetime(2014,6,25), freq='1Min')
0 commit comments