Merge pull request #93 from wholmgren/pvsystem

Location demotion and PVSystem/LocalizedPVSystem/ModelChain addition

Author: wholmgren

appveyor.yml

@@ -31,11 +31,13 @@ install:
     - "python --version"
     - "python -c \"import struct; print(struct.calcsize('P') * 8)\""
 
-    # install xray and depenencies
-    - "conda install --yes --quiet pip numpy scipy pandas nose pytz ephem numba"
+    # install depenencies
+    - "conda install --yes --quiet pip numpy scipy=0.16.0 pandas nose pytz ephem numba"
+
+    # install pvlib
     - "python setup.py install"
 
 build: false
 
 test_script:
-    - "nosetests -v pvlib"
+    - "nosetests -v pvlib"

ci/requirements-py27-min.yml

@@ -2,10 +2,8 @@ name: test_env
 dependencies:
     - python=2.7 
     - numpy==1.8.2
-    - scipy
     - pandas==0.13.1
     - nose
     - pytz
-    - ephem
     - pip:
         - coveralls

docs/environment.yml

@@ -1,13 +1,13 @@
 name: pvlib
 dependencies:
-    - python=2.7 
+    - python=2.7
     - numpy
     - scipy
     - pandas
     - pytz
     - ephem
     - numba
-    - ipython
+    - ipython=4.0.1
     - sphinx
     - numpydoc
     - matplotlib

docs/sphinx/source/_static/.gitignore

@@ -0,0 +1,55 @@
+.. _classes:
+
+Classes
+=======
+
+pvlib-python provides a collection of classes
+for users that prefer object-oriented programming.
+These classes can help users keep track of data in a more organized way,
+and can help to simplify the modeling process.
+The classes do not add any functionality beyond the procedural code.
+Most of the object methods are simple wrappers around the
+corresponding procedural code.
+
+Location
+--------
+.. autoclass:: pvlib.location.Location
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+PVSystem
+--------
+.. autoclass:: pvlib.pvsystem.PVSystem
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+ModelChain
+----------
+.. autoclass:: pvlib.modelchain.ModelChain
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+LocalizedPVSystem
+-----------------
+.. autoclass:: pvlib.pvsystem.LocalizedPVSystem
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+SingleAxisTracker
+-----------------
+.. autoclass:: pvlib.tracking.SingleAxisTracker
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+LocalizedSingleAxisTracker
+--------------------------
+.. autoclass:: pvlib.tracking.LocalizedSingleAxisTracker
+    :members:
+    :undoc-members:
+    :show-inheritance:
+

docs/sphinx/source/classes.rst

@@ -37,6 +37,9 @@ def __getattr__(cls, name):
 
 # -- General configuration ------------------------------------------------
 
+# turns off numpydoc autosummary warnings
+numpydoc_show_class_members = False
+
 # If your documentation needs a minimal Sphinx version, state it here.
 #needs_sphinx = '1.0'
 
@@ -127,7 +130,15 @@ def __getattr__(cls, name):
 
 # The theme to use for HTML and HTML Help pages.  See the documentation for
 # a list of builtin themes.
-html_theme = 'default'
+# on_rtd is whether we are on readthedocs.org
+on_rtd = os.environ.get('READTHEDOCS', None) == 'True'
+
+if not on_rtd:  # only import and set the theme if we're building docs locally
+    import sphinx_rtd_theme
+    html_theme = 'sphinx_rtd_theme'
+    html_theme_path = [sphinx_rtd_theme.get_html_theme_path()]
+else:
+    html_theme = 'default'
 
 # Theme options are theme-specific and customize the look and feel of a theme
 # further.  For a list of options available for each theme, see the

docs/sphinx/source/conf.py

@@ -60,11 +60,12 @@ Contents
    :maxdepth: 2
 
    self
+   package_overview
    whatsnew
+   modules
+   classes
    comparison_pvlib_matlab
    variables_style_rules
-   pvlib
-
 
 
 Indices and tables

docs/sphinx/source/index.rst

@@ -1,71 +1,79 @@
 Modules
 =======
 
-atmosphere module
+atmosphere
 -----------------
 
 .. automodule:: pvlib.atmosphere
     :members:
     :undoc-members:
     :show-inheritance:
 
-clearsky module
+clearsky
 ----------------
 
 .. automodule:: pvlib.clearsky
     :members:
     :undoc-members:
     :show-inheritance:
 
-irradiance module
+irradiance
 -----------------
 
 .. automodule:: pvlib.irradiance
     :members:
     :undoc-members:
     :show-inheritance:
 
-location module
+location
 ---------------
 
 .. automodule:: pvlib.location
     :members:
     :undoc-members:
     :show-inheritance:
 
-pvsystem module
+modelchain
+----------
+
+.. automodule:: pvlib.modelchain
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+pvsystem
 ---------------
 
 .. automodule:: pvlib.pvsystem
     :members:
     :undoc-members:
     :show-inheritance:
 
-solarposition module
+solarposition
 --------------------
 
 .. automodule:: pvlib.solarposition
     :members:
     :undoc-members:
     :show-inheritance:
 
-tmy module
+tmy
 --------------------
 
 .. automodule:: pvlib.tmy
     :members:
     :undoc-members:
     :show-inheritance:
 
-tracking module
+tracking
 --------------------
 
 .. automodule:: pvlib.tracking
     :members:
     :undoc-members:
     :show-inheritance:
 
-tools module
+tools
 --------------------
 
 .. automodule:: pvlib.tools