Merge pull request #48 from NREL/distribution_prep

Distribution prep

.gitignore

@@ -11,3 +11,6 @@
 
 docs/.ipynb_checkpoints/degradation_example-checkpoint.ipynb
 *.ipynb_checkpoints*
+
+# ignore egg-info
+rdtools.egg-info*

README.md

@@ -42,9 +42,12 @@ of instrument errors or irradiance sensor drift, such as in the above analysis.
 
 ## Install RdTools using pip
 
-RdTools can be installed into Python from the command line.
+RdTools can be installed automatically into Python from PyPI using the command line:  
+`pip install rdtools`
 
-1. Clone or download the rdtools repository.
+Alternatively it can be installed mannually using the command line:  
+
+1. Download a [release](https://github.com/NREL/rdtools/releases) (Or to work with a development version, clone or download the rdtools repository).
 2. Navigate to the repository: `cd rdtools`
 3. Install via pip: `pip install .`
 

rdtools/clearsky_temperature.py

@@ -8,10 +8,26 @@
 
 def get_clearsky_tamb(times, latitude, longitude, window_size=40, gauss_std=20):
     '''
-    :param times:       DateTimeIndex in local time
-    :param latitude:    float degrees
-    :param longitude:   float degrees
-    :return:            pandas Series of cell sky ambient temperature
+    Description
+    -----------
+    Estimates the ambient temperature at latitude and longitude for the given times
+
+    Parameters
+    ----------
+    times:       DateTimeIndex in local time
+    latitude:    float degrees
+    longitude:   float degrees
+
+    Returns
+    -------
+    pandas Series of clear sky ambient temperature
+
+    Reference
+    ---------
+    Uses data from images created by Jesse Allen, NASA's Earth Observatory
+    using data courtesy of the MODIS Land Group.
+    https://neo.sci.gsfc.nasa.gov/view.php?datasetId=MOD_LSTD_CLIM_M
+    https://neo.sci.gsfc.nasa.gov/view.php?datasetId=MOD_LSTN_CLIM_M
     '''
 
     filepath = pkg_resources.resource_filename('rdtools', 'data/temperature.hdf5')

setup.cfg

@@ -9,3 +9,6 @@ versionfile_source = rdtools/_version.py
 versionfile_build = rdtools/_version.py
 tag_prefix = ''
 parentdir_prefix = rdtools-
+
+[metadata]
+description-file = README.md

setup.py

@@ -9,7 +9,7 @@
 import versioneer
 
 
-DESCRIPTION = 'Functions for analytics the degradation of photovoltaic systems.'
+DESCRIPTION = 'Functions for analyzing the degradation of photovoltaic systems.'
 
 LONG_DESCRIPTION = """
 Rdtools is a collection of tools for the analysis of photovoltaic degradation.
@@ -20,7 +20,7 @@
 DISTNAME = 'rdtools'
 LICENSE = 'MIT'
 AUTHOR = 'Rdtools Python Developers'
-MAINTAINER_EMAIL = 'michael.deceglie@nrel.gov'
+MAINTAINER_EMAIL = 'RdTools@nrel.gov'
 
 URL = 'https://github.com/NREL/rdtools'
 
@@ -39,8 +39,8 @@
 TESTS_REQUIRE = ['']
 
 CLASSIFIERS = [
-    'Development Status :: 1 - Beta',
-    'License :: MIT License',
+    'Development Status :: 4 - Beta',
+    'License :: OSI Approved :: MIT License',
     'Operating System :: OS Independent',
     'Intended Audience :: Science/Research',
     'Programming Language :: Python',
@@ -49,6 +49,16 @@
     'Topic :: Scientific/Engineering',
 ]
 
+KEYWORDS = [
+    'photovoltaic',
+    'solar',
+    'analytics',
+    'analysis',
+    'performance',
+    'degradation',
+    'PV'
+]
+
 setuptools_kwargs = {
     'zip_safe': False,
     'scripts': [],
@@ -58,15 +68,22 @@
 # set up packages to be installed and extensions to be compiled
 PACKAGES = ['rdtools']
 
+PACKAGE_DATA = {
+    'rdtools': 'rdtools/data/temperature.hdf5'
+}
+
 setup(name=DISTNAME,
       version=versioneer.get_version(),
       cmdclass=versioneer.get_cmdclass(),
       packages=PACKAGES,
+      keywords=KEYWORDS,
       install_requires=INSTALL_REQUIRES,
       tests_require=TESTS_REQUIRE,
+      package_data=PACKAGE_DATA,
       description=DESCRIPTION,
       long_description=LONG_DESCRIPTION,
       author=AUTHOR,
+      author_email=AUTHOR,
       maintainer_email=MAINTAINER_EMAIL,
       license=LICENSE,
       url=URL,