fix #18 by making pykdtree a optional requirement

- add note about optional requirement to readme - modify changelog
TUW-GEO · May 12, 2015 · 1c04f8a · 1c04f8a
1 parent 6f04636
commit 1c04f8a
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 1 deletion.
diff --git a/CHANGES.md b/CHANGES.md
@@ -1,5 +1,6 @@
 # v0.1.2 #
 - fix issue #19 by refactoring the iterable checking into own function
+- made pykdtree an optional requirement see issue #18
 
 # v0.1.1 #
 - added support for saving more subsets and loading a certain one in/from a netcdf grid file

diff --git a/README.md b/README.md
@@ -11,6 +11,10 @@ For now the main features are:
 - Storage of grids and loading grids from CF-compatible netCDF files
 - Calculation of lookup tables between grids
 
+## Optional Requirements
+
+- [pykdtree](https://github.com/storpipfugl/pykdtree) or [scipy](http://www.scipy.org/) if you want to use the nearest neighbor search. pykdtree is much faster than the scipy implementation but it is at the moment not available for Windows systems.
+
 # Documentation
 
 [![Documentation Status](https://readthedocs.org/projects/pygeogrids/badge/?version=latest)](http://pygeogrids.readthedocs.org/)

diff --git a/requirements.txt b/requirements.txt
@@ -1,6 +1,5 @@
 # Add your requirements here like:
 numpy
-pykdtree
 netcdf4
 # scipy>=0.9