Skip to content

Commit e1e7ce9

Browse files
committed
more readme updates. add conda install directions!
1 parent 305c958 commit e1e7ce9

File tree

1 file changed

+38
-24
lines changed

1 file changed

+38
-24
lines changed

README.md

Lines changed: 38 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -8,6 +8,7 @@ pvlib-python
88

99
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

11+
1112
Documentation
1213
=============
1314

@@ -17,48 +18,50 @@ Full documentation can be found at [readthedocs](http://pvlib-python.readthedocs
1718
Contributing
1819
============
1920

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.
2122

2223

2324
Installation
2425
============
2526

2627
If you have Python
2728
------------------
28-
To obtain the most recent stable release, just use ``pip``:
29+
To obtain the most recent stable release, just use ``pip`` or ``conda``:
2930

3031
```
31-
pip install pvlib-python
32+
pip install pvlib
33+
```
34+
3235
```
36+
conda install -c http://conda.anaconda.org/pvlib pvlib
37+
```
38+
39+
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.
3340

3441

3542
If you don't have Python
3643
------------------------
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.
3845

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/).
4347

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:
48+
2. Install pvlib: ``conda install -c http://conda.anaconda.org/pvlib pvlib``
4549

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+
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).
5051

51-
Many good online resources exist for getting started with scientific Python. The [pandas tutorial]() is particularly good.
5252

53-
54-
Working at the bleeding-edge
53+
Working at the bleeding edge
5554
----------------------------
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:
5856

59-
```
60-
pip install git+https://github.com/pvlib/pvlib-python.git
61-
```
57+
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.
6265

6366

6467
NREL SPA algorithm
@@ -73,8 +76,17 @@ To use the NREL SPA algorithm, a pip install from the web cannot be used. Instea
7376
4. From the ``pvlib-python`` directory, run ``pip uninstall pvlib`` followed by ``pip install . ``
7477

7578

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+
7890
```
7991
# built-in imports
8092
import sys
@@ -95,14 +107,16 @@ tus = Location(32.2, -111, 'MST', 700)
95107
times = pd.date_range(start=datetime.datetime(2014,6,24), end=datetime.datetime(2014,6,25), freq='1Min')
96108
97109
# calculate the solar position
98-
solpos = pvlib.solarposition.get_solarposition(times, tus, method='pyephem')
110+
solpos = pvlib.solarposition.get_solarposition(times, tus)
99111
solpos.plot()
100112
101113
# calculate clear sky data
102114
tus_cs = pvlib.clearsky.ineichen(times, tus, airmass_model='young1994')
103115
tus_cs.plot()
104116
```
105117

118+
Many good online resources exist for getting started with scientific Python.
119+
106120

107121
License
108122
=======

0 commit comments

Comments
 (0)