General cleanup (#39)

* Drop stub `dask_image.core` file This file was generated by the cookiecutter template and is no longer needed or used. So just go ahead and drop it. * Fill out feature section of README Lists some common functionality included in this package. * Drop Credits section from the README This was generated using Cookiecutter. Though based on feedback this was deemed unpolished. So this drops it. * Drop the Usage doc section This was created by the cookiecutter template, but is not being used. Instead users should read the API documentation for how to use different functions. Hopefully this will be filled out in time with some better examples. * Improve index page title * Convert `imread` into a subpackage This shouldn't be strictly necessary. However this does allow `imread` to match other subpackages in `dask-image`. * Bump `pims` requirement for RTD docs In the ReadTheDocs build, PIMS 0.3.3 has a bug revealed by a change in six. However this was fixed in subsequent versions of PIMS. So just go ahead and bump the PIMS requirement to 0.4.1 to match what we are using in CI. * Refresh `setup.py` requirements Go ahead and refresh the requirements in `setup.py` to match those being used in CIs. While the older versions likely work without issues, it is easier to just require slightly newer (though still rather old) versions of our dependencies generally. Should make it easier for packagers to follow as well. * Explicitly require `dask[array]` We use Dask particularly with Dask Array support. For `pip` this means, we should specify the extras we need as well. So require `dask[array]` in `setup.py` to make sure these extra dependencies are pulled in too.
dask · Aug 31, 2018 · d29831a · d29831a
1 parent 126d0a6
commit d29831a
Show file tree

Hide file tree

Showing 8 changed files with 12 additions and 24 deletions.
diff --git a/README.rst b/README.rst
@@ -38,13 +38,9 @@ Distributed image processing
 Features
 --------
 
-* TODO
-
-Credits
----------
-
-This package was created with Cookiecutter_ and the `dask-image/dask-image-cookiecutter`_ project template.
-
-.. _Cookiecutter: https://github.com/audreyr/cookiecutter
-.. _`dask-image/dask-image-cookiecutter`: https://github.com/dask-image/dask-image-cookiecutter
-
+* Support focuses on Dask Arrays.
+* Provides support for loading image files.
+* Implements commonly used N-D filters.
+* Includes a few N-D Fourier filters.
+* Provides some functions for working with N-D label images.
+* Supports a few N-D morphological operators.
diff --git a/dask_image/imread.py → dask_image/imread/__init__.py b/dask_image/imread.py → dask_image/imread/__init__.py
diff --git a/docs/index.rst b/docs/index.rst
@@ -1,5 +1,5 @@
-Welcome to dask-image's documentation!
-======================================
+Image processing with Dask Arrays
+=================================
 
 Contents:
 
@@ -8,7 +8,6 @@ Contents:
 
    Readme <readme>
    installation
-   usage
    api
    contributing
    authors

diff --git a/docs/usage.rst b/docs/usage.rst
diff --git a/environment_doc.yml b/environment_doc.yml
@@ -10,7 +10,7 @@ dependencies:
   - sphinx_rtd_theme==0.4.1
   - dask==0.13.0
   - numpy==1.11.3
-  - pims==0.3.3
+  - pims==0.4.1
   - slicerator==0.9.8
   - pip:
     - slicerator==0.9.8
diff --git a/setup.py b/setup.py
@@ -29,10 +29,10 @@ def run_tests(self):
     history = history_file.read()
 
 requirements = [
-    "dask >=0.13.0",
+    "dask[array] >=0.13.0",
     "numpy >=1.11.3",
-    "scipy >=0.18.1",
-    "pims >=0.3.3",
+    "scipy >=0.19.1",
+    "pims >=0.4.1",
 ]
 
 test_requirements = [

diff --git a/dask_image/core.py → ...s/test_dask_image/test_imread/__init__.py b/dask_image/core.py → ...s/test_dask_image/test_imread/__init__.py
diff --git a/tests/test_dask_image/test_imread.py → .../test_dask_image/test_imread/test_core.py b/tests/test_dask_image/test_imread.py → .../test_dask_image/test_imread/test_core.py