Skip to content

Commit

Permalink
add all, replace complete with optional
Browse files Browse the repository at this point in the history
  • Loading branch information
wholmgren committed Sep 10, 2018
1 parent 38ecc70 commit c7b0a16
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 13 deletions.
14 changes: 8 additions & 6 deletions docs/sphinx/source/installation.rst
Original file line number Diff line number Diff line change
Expand Up @@ -75,7 +75,7 @@ non-editable way, use one of the following commands to install pvlib-python::

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

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
Expand Down Expand Up @@ -185,10 +185,12 @@ Good news -- installing the source code is the easiest part!
With your conda/virtual environment still active...

#. **Install** pvlib-python in "development mode" by running
``pip install -e /path/to/your/pvlib-python``.
You remember this path from the clone step, right? It's probably
something like ``C:\Users\%USER%\Documents\GitHub\pvlib-python``
(Windows) or ``/Users/%USER%/Documents/pvlib-python`` (Mac).
``pip install -e .`` from within the directory you previously cloned.
Consider installing pvlib using ``pip install -e .[all]`` so that
you can run the unit tests and build the documentation.
Your clone directory is probably similar to
``C:\Users\%USER%\Documents\GitHub\pvlib-python``(Windows) or
``/Users/%USER%/Documents/pvlib-python`` (Mac).
#. **Test** your installation by running ``python -c 'import pvlib'``.
You're good to go if it returns without an exception.

Expand Down Expand Up @@ -235,7 +237,7 @@ The Anaconda distribution includes most of the above packages.

Alternatively, users may install all optional dependencies using

pip install pvlib[complete]
pip install pvlib[optional]


.. _nrelspa:
Expand Down
9 changes: 5 additions & 4 deletions docs/sphinx/source/whatsnew/v0.6.0.rst
Original file line number Diff line number Diff line change
Expand Up @@ -119,10 +119,11 @@ Enhancements
* 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 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]``. doc and test options are also available.
(:issue:`553`, :issue:`483`)
* pvlib now ships with a pvlib[optional] installation option to automatically
install packages needed to support additional pvlib features:
``pip install pvlib[optional]``. Additional installation options include
`doc` (requirements for minimal documentation build), `test` (requirements
for testing), and `all` (optional + doc + test). (:issue:`553`, :issue:`483`)
* Set default alpha to 1.14 in :func:`~pvlib.atmosphere.angstrom_aod_at_lambda` (:issue:`563`)


Expand Down
3 changes: 1 addition & 2 deletions readthedocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -3,5 +3,4 @@ python:
use_system_site_packages: true
pip_install: true
extra_requirements:
- complete
- doc
- all
3 changes: 2 additions & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -44,11 +44,12 @@
]
TESTS_REQUIRE = ['pytest', 'pytest-cov', 'pytest-mock', 'nose']
EXTRAS_REQUIRE = {
'complete': ['scipy', 'tables', 'numba', 'siphon', 'netcdf4', 'ephem'],
'optional': ['scipy', 'tables', 'numba', 'siphon', 'netcdf4', 'ephem'],
'doc': ['sphinx', 'ipython', 'sphinx_rtd_theme', 'numpydoc',
'matplotlib'],
'test': TESTS_REQUIRE
}
EXTRAS_REQUIRE['all'] = sorted(set(sum(EXTRAS_REQUIRE.values(), [])))

CLASSIFIERS = [
'Development Status :: 4 - Beta',
Expand Down

0 comments on commit c7b0a16

Please sign in to comment.