update docs for v3.0 (#45)

* use logical indexing

* add release robot and use logical indexing

* cherry pick dulwich 0.16.3

* prepare for v3.0rc1

* remove CHANGES
* change README.md to rst
* add README to setup
* add version and release to documentation index

Signed-off-by: Mark Mikofski <[email protected]>

* remove version, add dulwich to reqs

Author: mikofski

.gitignore

@@ -27,3 +27,4 @@ benchmark_*/
 
 # virtualenv
 venv/
+.coverage

AUTHORS.md

@@ -1,6 +1,5 @@
 Authors
 =======
-* Nicolas Zweibaum <[email protected]>
-* Mark Mikofski <[email protected]>
 * Bennet Emil Meyers <[email protected]>
-
+* Mark Mikofski <[email protected]>
+* Nicolas Zweibaum <[email protected]>

CHANGES.md

@@ -0,0 +1,35 @@
+PVMismatch
+==========
+
+An explicit Python PV system IV & PV curve trace calculator which can
+also calculate mismatch.
+
+|Build Status|
+
+Installation
+------------
+
+PVMismatch is on `PyPI <https://pypi.python.org/pypi/pvmismatch>`__. Install it
+with `pip <https://pip.pypa.io/en/stable/>`__:
+
+::
+
+    $ pip install pvmismatch
+
+Requirements
+------------
+
+PVMismatch requires NumPy, SciPy and matplotlib. These packages are available
+from PyPI, `Christoph Gohlke <http://www.lfd.uci.edu/~gohlke/pythonlibs/>`__
+and Anaconda. You must install them prior to using PVMismatch.
+
+Usage
+-----
+
+Please see the `documenation <http://sunpower.github.io/PVMismatch/>`__ for
+tutorials and API. Bugs and feature requests can be reported on
+`GitHub <https://github.com/SunPower/PVMismatch/issues>`__. The change
+history is also on `GitHub <https://github.com/SunPower/releases/>`__.
+
+.. |Build Status| image:: https://travis-ci.org/SunPower/PVMismatch.svg?branch=master
+   :target: https://travis-ci.org/SunPower/PVMismatch

README.md

@@ -24,6 +24,19 @@
 :mod:`pvmismatch.pv_tk`.
 """
 
+import os
+import importlib
+
+# try to import Dulwich or create dummies
+try:
+    from dulwich.contrib.release_robot import get_current_version
+    from dulwich.repo import NotGitRepository
+except ImportError:
+    NotGitRepository = NotImplementedError
+
+    def get_current_version():
+        return NotGitRepository
+
 # import pvmismatch_lib modules so to match old API
 import pvmismatch.pvmismatch_lib.pvconstants as pvconstants
 import pvmismatch.pvmismatch_lib.pvcell as pvcell
@@ -39,7 +52,32 @@
 PVstring = pvstring.PVstring
 PVsystem = pvsystem.PVsystem
 
-__author__ = 'mmikofski'
-__version__ = '3.0'
+# Dulwich Release Robot
+BASEDIR = os.path.dirname(__file__)  # this directory
+VER_FILE = 'version'  # name of file to store version
+# use release robot to try to get current Git tag
+try:
+    GIT_TAG = get_current_version()
+except NotGitRepository:
+    GIT_TAG = None
+# check version file
+try:
+    version = importlib.import_module('%s.%s' % (__name__, VER_FILE))
+except ImportError:
+    VERSION = None
+else:
+    VERSION = version.VERSION
+# update version file if it differs from Git tag
+if GIT_TAG is not None and VERSION != GIT_TAG:
+    with open(os.path.join(BASEDIR, VER_FILE + '.py'), 'w') as vf:
+        vf.write('VERSION = "%s"\n' % GIT_TAG)
+else:
+    GIT_TAG = VERSION  # if Git tag is none use version file
+VERSION = GIT_TAG  # version
+
+__author__ = 'Mark Mikofski'
+__email__ = u'[email protected]'
+__url__ = u'https://github.com/SunPower/PVMismatch'
+__version__ = VERSION
 __release__ = 'Kenya Ketchup'
 __all__ = ['pvconstants', 'pvcell', 'pvmodule', 'pvstring', 'pvsystem']

README.rst

@@ -6,7 +6,20 @@
 Welcome to PVMismatch's documentation!
 ======================================
 
+Version: |version| (|release|)
+
+
+Announcements
+-------------
+Thanks to Bennet Meyers you should see huge memory and speed improvements since
+new cell, module and string objects are only created when they are needed to
+differentiate cells by irradiance or temperature. However this can lead to
+unexpected behavior when changing other cell properties without first making a
+copy of the original cell.
+
+
 Contents:
+---------
 
 .. toctree::
    :maxdepth: 2

pvmismatch/__init__.py

@@ -275,7 +275,7 @@ def setSuns(self, Ee, cells=None):
                 Ee = np.array(Ee)
                 unique_ee = np.unique(Ee)
                 for a_Ee in unique_ee:
-                    cells_subset = cells[np.where(Ee == a_Ee)]
+                    cells_subset = cells[Ee == a_Ee]
                     cells_to_update = [self.pvcells[i] for i in cells_subset]
                     old_pvcells = dict.fromkeys(cells_to_update)
                     for cell_id, pvcell in zip(cells_subset, cells_to_update):
@@ -345,7 +345,7 @@ def setTemps(self, Tc, cells=None):
                 Tc = np.array(Tc)
                 unique_tc = np.unique(Tc)
                 for a_Tc in unique_tc:
-                    cells_subset = cells[np.where(Tc == a_Tc)]
+                    cells_subset = cells[Tc == a_Tc]
                     cells_to_update = [self.pvcells[i] for i in cells_subset]
                     old_pvcells = dict.fromkeys(cells_to_update)
                     for cell_id, pvcell in zip(cells_subset, cells_to_update):

pvmismatch/docs/index.rst

@@ -2,3 +2,5 @@ nose
 numpy
 scipy
 matplotlib
+sphinx
+dulwich

pvmismatch/pvmismatch_lib/pvmodule.py

@@ -4,15 +4,24 @@
     from setuptools import setup
 except ImportError:
     from distutils.core import setup
-from pvmismatch import __version__, __name__
+from pvmismatch import __version__, __name__, __email__, __url__
+import os
 
+README = 'README.rst'
+try:
+    with open(os.path.join(os.path.dirname(__file__), README), 'r') as readme:
+        README = readme.read()
+except IOError:
+    pass
 
 setup(name=__name__,
       version=__version__,
       description='PV Mismatch Calculator',
+      long_description=README,
       author=__author__,
-      author_email='[email protected]',
-      url='https://github.com/SunPower/PVMismatch',
+      author_email=__email__,
+      url=__url__,
+      license='BSD 3-clause',
       packages=['pvmismatch', 'pvmismatch.pvmismatch_lib',
                 'pvmismatch.pvmismatch_tk'],
       requires=['numpy (>=1.8)', 'matplotlib (>=1.3)', 'scipy (>=0.12.0)'],