|
| 1 | +.. _installation: |
| 2 | + |
| 3 | +Installation |
| 4 | +============ |
| 5 | + |
| 6 | +Installing pvlib-python is similar to installing most other scientific |
| 7 | +python packages. The instructions below describe how to install |
| 8 | +pvlib-python under a few different conditions. Most of the information |
| 9 | +on the `Pandas installation page |
| 10 | +<http://pandas.pydata.org/pandas-docs/stable/install.html>`_ is also |
| 11 | +applicable to pvlib-python. |
| 12 | + |
| 13 | +If you have Python |
| 14 | +------------------ |
| 15 | + |
| 16 | +To obtain the most recent stable release of pvlib-python, use |
| 17 | +`conda <http://conda.pydata.org/docs/>`_ or `pip <https://pip.pypa.io>`_:: |
| 18 | + |
| 19 | + conda install -c pvlib pvlib |
| 20 | + |
| 21 | + pip install pvlib |
| 22 | + |
| 23 | +If your system complains that you don't have access privileges or asks |
| 24 | +for a password then you're probably trying to install pvlib into your |
| 25 | +system's Python distribution. This is usually a bad idea and you should |
| 26 | +instead follow the :ref:`nopython` instructions below. |
| 27 | + |
| 28 | +.. _nopython: |
| 29 | + |
| 30 | +If you don't have Python |
| 31 | +------------------------ |
| 32 | + |
| 33 | +There are many ways to install Python on your system, but the Anaconda |
| 34 | +Scientific Python distribution provides by far the easiest way for new |
| 35 | +users to get started. Anaconda includes all of the popular libraries |
| 36 | +that you'll need for pvlib, including Pandas, NumPy, and SciPy. |
| 37 | +"Anaconda installs cleanly into a single directory, does not require |
| 38 | +Administrator or root privileges, does not affect other Python installs |
| 39 | +on your system, or interfere with OS
8000
X Frameworks." -Anaconda |
| 40 | +Documentation. |
| 41 | + |
| 42 | +#. Install the full Anaconda Scientific Python distribution available |
| 43 | + `here <https://store.continuum.io/cshop/anaconda/>`_ |
| 44 | +#. Install pvlib: ``conda install -c pvlib pvlib`` |
| 45 | + |
| 46 | +If you have trouble, see the `Anaconda |
| 47 | +FAQ <http://docs.continuum.io/anaconda/faq.html>`_, Google your error |
| 48 | +messages, or make a new issue on our `Issues |
| 49 | +page <https://github.com/pvlib/pvlib-python/issues>`_. |
| 50 | + |
| 51 | + |
| 52 | +Working at the bleeding edge |
| 53 | +---------------------------- |
| 54 | + |
| 55 | +We strongly recommend working in a `virtual environment |
| 56 | +<http://astropy.readthedocs.org/en/latest/development/workflow/ |
| 57 | +virtual_pythons.html>`_ if you're going to use the development versions |
| 58 | +of the code. There are many ways to use virtual environments in Python, |
| 59 | +but Anaconda again provides the easiest solution: |
| 60 | + |
| 61 | +#. Create a new conda environment for pvlib and pre-install a |
| 62 | + handful of packages into the environment: |
| 63 | + ``conda create --name pvlibdev python pandas scipy`` |
| 64 | +#. Activate the new environment: ``source activate pvlibdev`` |
| 65 | +#. Install the latest development version of pvlib: |
| 66 | + |
| 67 | + #. If you don't plan to modify the source-code: |
| 68 | + ``pip install git+https://github.com/pvlib/pvlib-python.git`` |
| 69 | + #. If you do plan to modify the source code: |
| 70 | + Use the GitHub GUI application or git command-line tool to |
| 71 | + clone this repository to your computer, then navigate your |
| 72 | + command-line to the top-level pvlib-python directory, |
| 73 | + then ``pip install -e .`` |
| 74 | + |
| 75 | +#. You may also consider installing additional packages into your |
| 76 | + development environment: |
| 77 | + ``conda install jupyter ipython seaborn nose flake8`` |
| 78 | + |
| 79 | +The `conda documentation |
| 80 | +<http://conda.pydata.org/docs/using/index.html>`_ has more information |
| 81 | +on how to use virtual environments. You can also add ``-h`` to most |
| 82 | +conda commands to get help (e.g. ``conda -h`` or ``conda env -h``) |
0 commit comments