From 26d9093bfae429309482e4a21100a25d8892f400 Mon Sep 17 00:00:00 2001 From: Michael Deceglie Date: Tue, 31 Oct 2017 14:23:42 -0600 Subject: [PATCH 1/9] add readme to setup.cfg --- setup.cfg | 3 +++ 1 file changed, 3 insertions(+) diff --git a/setup.cfg b/setup.cfg index 4dc5f5b3..52fde7ab 100644 --- a/setup.cfg +++ b/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 From 7f3673d803fec6bef8e543f41e3467bca385c898 Mon Sep 17 00:00:00 2001 From: Michael Deceglie Date: Tue, 31 Oct 2017 14:55:23 -0600 Subject: [PATCH 2/9] include keywords and package_data in setup --- setup.py | 18 +++++++++++++++++- 1 file changed, 17 insertions(+), 1 deletion(-) diff --git a/setup.py b/setup.py index 8e801ce5..b84f3fea 100755 --- a/setup.py +++ b/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. @@ -49,6 +49,16 @@ 'Topic :: Scientific/Engineering', ] +KEYWORDS = [ + 'photovoltaic', + 'solar', + 'analytics', + 'analysis', + 'performance', + 'degradation', + 'PV' +] + setuptools_kwargs = { 'zip_safe': False, 'scripts': [], @@ -58,12 +68,18 @@ # 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, From d58788d430450f66e535a84d7ee4ae57d77be7ac Mon Sep 17 00:00:00 2001 From: Michael Deceglie Date: Tue, 31 Oct 2017 16:20:27 -0600 Subject: [PATCH 3/9] Add author email and get_clearsky_tamb doc --- rdtools/clearsky_temperature.py | 24 ++++++++++++++++++++---- setup.py | 1 + 2 files changed, 21 insertions(+), 4 deletions(-) diff --git a/rdtools/clearsky_temperature.py b/rdtools/clearsky_temperature.py index 1562be52..b716c0c1 100644 --- a/rdtools/clearsky_temperature.py +++ b/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') diff --git a/setup.py b/setup.py index b84f3fea..c2af74da 100755 --- a/setup.py +++ b/setup.py @@ -83,6 +83,7 @@ description=DESCRIPTION, long_description=LONG_DESCRIPTION, author=AUTHOR, + author_email=AUTHOR, maintainer_email=MAINTAINER_EMAIL, license=LICENSE, url=URL, From 7b138ca613718deb3a9b7cc15c76c13daa98015d Mon Sep 17 00:00:00 2001 From: Michael Deceglie Date: Tue, 31 Oct 2017 22:05:24 -0600 Subject: [PATCH 4/9] ignore dist building files --- .gitignore | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.gitignore b/.gitignore index 640ddecf..6dc2ac38 100644 --- a/.gitignore +++ b/.gitignore @@ -11,3 +11,6 @@ docs/.ipynb_checkpoints/degradation_example-checkpoint.ipynb *.ipynb_checkpoints* + +# ignore egg-info +rdtools.egg-info* \ No newline at end of file From d62ca4fa1de188b443f50befb558104b984092ee Mon Sep 17 00:00:00 2001 From: Michael Deceglie Date: Tue, 31 Oct 2017 22:43:16 -0600 Subject: [PATCH 5/9] replace apostrophe --- rdtools/clearsky_temperature.py | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/rdtools/clearsky_temperature.py b/rdtools/clearsky_temperature.py index b716c0c1..3c53ae87 100644 --- a/rdtools/clearsky_temperature.py +++ b/rdtools/clearsky_temperature.py @@ -24,7 +24,7 @@ def get_clearsky_tamb(times, latitude, longitude, window_size=40, gauss_std=20): Reference --------- - Uses data from images created by Jesse Allen, NASA’s Earth Observatory + 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 From db2486a5e5c4a43fcb92ccbad00e9035eef59b2c Mon Sep 17 00:00:00 2001 From: Michael Deceglie Date: Tue, 31 Oct 2017 23:19:48 -0600 Subject: [PATCH 6/9] Make classifiers compliant --- setup.py | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/setup.py b/setup.py index c2af74da..decd2c31 100755 --- a/setup.py +++ b/setup.py @@ -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', From 752d1ae7ae09691a1ba5f344e12216e5acb9269b Mon Sep 17 00:00:00 2001 From: Michael Deceglie Date: Wed, 1 Nov 2017 11:30:25 -0600 Subject: [PATCH 7/9] Remove nose requirement and update email to rdtools@nrel.gov --- requirements.txt | 1 - setup.py | 2 +- 2 files changed, 1 insertion(+), 2 deletions(-) diff --git a/requirements.txt b/requirements.txt index 95ac68bb..22d9aff9 100644 --- a/requirements.txt +++ b/requirements.txt @@ -1,4 +1,3 @@ -nose==1.3.7 numpy==1.11.2 pandas==0.19.2 patsy==0.4.1 diff --git a/setup.py b/setup.py index decd2c31..8d41fed6 100755 --- a/setup.py +++ b/setup.py @@ -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' From 5401048c09d4310f488607b12ba6d75070dc46c2 Mon Sep 17 00:00:00 2001 From: Michael Deceglie Date: Wed, 1 Nov 2017 11:45:13 -0600 Subject: [PATCH 8/9] Update installation instructions --- README.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index 0f76a8aa..bebc1c04 100644 --- a/README.md +++ b/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 .` From 01c6a7609fe58531c0e3e8b7bf76ba064483674e Mon Sep 17 00:00:00 2001 From: Michael Deceglie Date: Wed, 1 Nov 2017 14:29:55 -0600 Subject: [PATCH 9/9] remove requirements.txt requirements are determined from setup.py --- requirements.txt | 11 ----------- 1 file changed, 11 deletions(-) delete mode 100644 requirements.txt diff --git a/requirements.txt b/requirements.txt deleted file mode 100644 index 22d9aff9..00000000 --- a/requirements.txt +++ /dev/null @@ -1,11 +0,0 @@ -numpy==1.11.2 -pandas==0.19.2 -patsy==0.4.1 -pvlib==0.4.1 -python-dateutil==2.6.0 -pytz==2016.7 -scipy==0.18.1 -six==1.10.0 -statsmodels==0.8.0 -versioneer==0.17 -wsgiref==0.1.2