Skip to content

Commit

Permalink
update doc notes
Browse files Browse the repository at this point in the history
  • Loading branch information
wholmgren committed Sep 9, 2018
1 parent 3c105e6 commit cd0bac6
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 4 deletions.
13 changes: 11 additions & 2 deletions docs/sphinx/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -73,6 +73,10 @@ non-editable way, use one of the following commands to install pvlib-python::
# best option if you know what you are doing
pip install pvlib

# get pvlib and optional dependencies from the Python Package Index
# another option if you know what you are doing
pip install pvlib[complete]

If your system complains that you don't have access privileges or asks
for a password then you're probably trying to install pvlib into your
system's Python distribution. This is usually a bad idea and you should
Expand Down Expand Up @@ -163,9 +167,9 @@ referred to as *conda environments*, but they're the same for our purposes.
#. **Create** a new conda environment for pvlib and pre-install
the required packages into the environment:
``conda create --name pvlibdev python pandas scipy``
#. **Activate** the new conda environment: ``source activate pvlibdev``
#. **Activate** the new conda environment: ``conda activate pvlibdev``
#. **Install** additional packages into your development environment:
``conda install jupyter ipython matplotlib seaborn pytest nose flake8``
``conda install jupyter ipython matplotlib pytest nose flake8``

The `conda documentation <https://conda.io/docs/index.html>`_ has more
information on how to use conda virtual environments. You can also add
Expand Down Expand Up @@ -229,6 +233,11 @@ include:

The Anaconda distribution includes most of the above packages.

Alternatively, users may install all optional dependencies using

pip install pvlib[complete]


.. _nrelspa:

NREL SPA algorithm
Expand Down
5 changes: 3 additions & 2 deletions docs/sphinx/source/whatsnew/v0.6.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -117,11 +117,12 @@ Enhancements
* Add irradiance.clearness_index_zenith_independent function. (:issue:`396`)
* Add checking for consistency between module_parameters and dc_model. (:issue:`417`)
* Add DC model methods ``'desoto'`` and ``'pvsyst'`` to ModelChain (:issue:`487`)
* Add the CEC module model in `pvsystem.calcparams_cec` and `ModelChain.cec`. (:issue:`463`)
* Add the CEC module model in `pvsystem.calcparams_cec` and `ModelChain.cec`. (:issue:`463`)
* Add DC model methods desoto and pvsyst to ModelChain (:issue:`487`)
* pvlib now ships with a pvlib[complete] installation option to automatically
install all packages needed to support all pvlib features:
``pip install pvlib[complete]`` (:issue:`553`, :issue:`483`)
``pip install pvlib[complete]``. doc and test options are also available.
(:issue:`553`, :issue:`483`)
* Set default alpha to 1.14 in :func:`~pvlib.atmosphere.angstrom_aod_at_lambda` (:issue:`563`)


Expand Down

0 comments on commit cd0bac6

Please sign in to comment.