Deliberately exclude pandas 0.24.0 and update dev environment creatio…

…n instructions (#228) * Deliberately exclude pandas 0.24.0 * Update README.md * Make README.md instructions clearer * Specify geopandas too and fix double apostrophes * Fix typo * Update RELEASE NOTES
IAMconsortium · May 8, 2019 · 205001a · 205001a
1 parent 4077929
commit 205001a
Show file tree

Hide file tree

Showing 3 changed files with 38 additions and 38 deletions.
diff --git a/README.md b/README.md
@@ -75,20 +75,19 @@ pip install -e .
 
 ### Development
 
-To setup a development environment,
+To setup a development environment, the simplest route is to make yourself 
+a conda environment and then follow the `Makefile`. 
 
-```
+```sh
 # pyam can be replaced with any other name
 # you don't have to specify your python version if you don't want
 conda create --name pyam pip python=X.Y.Z
-conda activate pyam  # may be source activate pyam or just activate pyam
-pip install -e .[tests,docs,deploy]
-# install other required packages (e.g. on a Unix like system)
-conda install -c conda-forge $(cat requirements.txt)
-# by hand also works e.g.
-conda install -c conda-forge cartopy geopandas
-# if you want to write notebooks
-pip install notebook nbconvert jupyter_contrib_nbextensions
+conda activate pyam  # may be  simply `source activate pyam` or just `activate pyam`
+# use the make file to create your development environment
+# (you only require the -B flag the first time, thereafter you can
+# just run `make virtual-environment` and it will only update if
+# environment definition files have been updaed)
+make -B virtual-environment
 ```
 
 To check everything has installed correctly,

diff --git a/RELEASE_NOTES.md b/RELEASE_NOTES.md
@@ -1,6 +1,7 @@
 
 # Next Release
 
+- [#228](https://github.com/IAMconsortium/pyam/pull/228) Update development environment creation instructions and make pandas requirement more specific
 - [#219](https://github.com/IAMconsortium/pyam/pull/219) Add ability to query metadata from iiasa data sources
 - [#214](https://github.com/IAMconsortium/pyam/pull/214) Tidy up requirements specifications a little
 - [#213](https://github.com/IAMconsortium/pyam/pull/213) Add support for IPCC colors, see the new tutorial "Using IPCC Color Palattes"

diff --git a/setup.py b/setup.py
@@ -23,21 +23,21 @@
 }
 
 REQUIREMENTS = [
-    "argparse",
-    "numpy",
-    "requests",
-    "pandas>=0.21.0",
-    "PyYAML",
-    "xlrd",
-    "xlsxwriter",
-    "matplotlib",
-    "seaborn",
-    "six",
+    'argparse',
+    'numpy',
+    'requests',
+    'pandas>=0.21.0,!=0.24.0',
+    'PyYAML',
+    'xlrd',
+    'xlsxwriter',
+    'matplotlib',
+    'seaborn',
+    'six',
 ]
 
 EXTRA_REQUIREMENTS = {
     'tests': ['coverage', 'coveralls', 'pytest', 'pytest-cov', 'pytest-mpl'],
-    'geoplots': ['geopandas', 'cartopy', 'gdal', 'fiona'],
+    'geoplots': ['geopandas<0.5.0', 'cartopy', 'gdal', 'fiona'],
     'deploy': ['twine', 'setuptools', 'wheel'],
 }
 
@@ -61,13 +61,13 @@ def run(self):
 
 
 CMDCLASS = versioneer.get_cmdclass()
-CMDCLASS.update({"test": RunTests})
+CMDCLASS.update({'test': RunTests})
 
 
 def main():
     print(logo)
     classifiers = [
-        "License :: OSI Approved :: Apache Software License",
+        'License :: OSI Approved :: Apache Software License',
     ]
     packages = [
         'pyam',
@@ -86,21 +86,21 @@ def main():
     install_requirements = REQUIREMENTS
     extra_requirements = EXTRA_REQUIREMENTS
     setup_kwargs = {
-        "name": "pyam-iamc",
-        "version": versioneer.get_version(),
-        "cmdclass": CMDCLASS,
-        "description": 'Analyze & Visualize Assessment Model Results',
-        "classifiers": classifiers,
-        "license": "Apache License 2.0",
-        "author": 'Matthew Gidden & Daniel Huppmann',
-        "author_email": 'matthew.gidden@gmail.com',
-        "url": 'https://github.com/IAMconsortium/pyam',
-        "packages": packages,
-        "package_dir": pack_dir,
-        "entry_points": entry_points,
-        "package_data": package_data,
-        "install_requires": install_requirements,
-        "extras_require": extra_requirements,
+        'name': 'pyam-iamc',
+        'version': versioneer.get_version(),
+        'cmdclass': CMDCLASS,
+        'description': 'Analyze & Visualize Assessment Model Results',
+        'classifiers': classifiers,
+        'license': 'Apache License 2.0',
+        'author': 'Matthew Gidden & Daniel Huppmann',
+        'author_email': 'matthew.gidden@gmail.com',
+        'url': 'https://github.com/IAMconsortium/pyam',
+        'packages': packages,
+        'package_dir': pack_dir,
+        'entry_points': entry_points,
+        'package_data': package_data,
+        'install_requires': install_requirements,
+        'extras_require': extra_requirements,
     }
     rtn = setup(**setup_kwargs)