Refactor package

.github/workflows/ci.yaml

@@ -20,4 +20,4 @@ jobs:
       - name: Install package
         run: python -m pip install .[opensimplex]
       - name: Test package
-        run: python -c "import topotoolbox as topo; dem = topo.GridObject.gen_random(); assert (dem.fillsinks() >= dem).z.all()"
+        run: python -c "import topotoolbox as topo; dem = topo.gen_random(); assert (dem.fillsinks() >= dem).z.all()"

docs/Makefile

@@ -9,7 +9,8 @@ SOURCEDIR     = .
 BUILDDIR      = _build
 
 EXAMPLEDIR    = ../examples
-DOCEXAMPLEDIR = $(SOURCEDIR)/_examples
+DOCEXAMPLEDIR = _examples
+AUTOSUMMARYDIR = _autosummary
 
 # Put it first so that "make" without argument is like "make help".
 help:
@@ -22,8 +23,18 @@ html:
 	@echo "Copying examples directory..."
 	@cp -r $(EXAMPLEDIR) $(DOCEXAMPLEDIR)
 	@$(SPHINXBUILD) -M html "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
-	@echo "Cleaning up examples directory..."
-	@rm -rf $(DOCEXAMPLEDIR)
+	@echo "Cleaning up _examples directory..."
+	@rm -rf $(DOCEXAMPLEDIR)/*
+	@echo "Cleaning up _autosummary directory..."
+	@rm -rf $(AUTOSUMMARYDIR)/*
+
+clean:
+	@echo "Removing everything under '_build'..."
+	@rm -rf $(BUILDDIR)/*
+	@echo "Cleaning up '_autosummary' directory..."
+	@rm -rf $(AUTOSUMMARYDIR)/*
+	@echo "Cleaning up '_examples' directory..."
+	@rm -rf $(DOCEXAMPLEDIR)/*
 
 # Catch-all target: route all unknown targets to Sphinx using the new
 # "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).

docs/api.rst

@@ -5,4 +5,11 @@ API Documentation
    :toctree: _autosummary
    :recursive:
 
-   topotoolbox
+   topotoolbox.GridObject
+   topotoolbox.read_tif
+   topotoolbox.load_dem
+   topotoolbox.get_dem_names
+   topotoolbox.get_cache_contents
+   topotoolbox.clear_cache
+   topotoolbox.gen_random
+   topotoolbox.gen_random_bool

examples/example_magic_funcs.ipynb

@@ -31,7 +31,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "dem = topo.GridObject.gen_random_bool(rows=4, columns=4)\n",
+    "dem = topo.gen_random_bool(rows=4, columns=4)\n",
     "for i in dem:\n",
     "    print(i)\n",
     "\n",
@@ -59,8 +59,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "dem1 = topo.GridObject.gen_random(rows=32, columns=32, hillsize=24)\n",
-    "dem2 = topo.GridObject.gen_random(rows=32, columns=32, hillsize=32)\n",
+    "dem1 = topo.gen_random(rows=32, columns=32, hillsize=24)\n",
+    "dem2 = topo.gen_random(rows=32, columns=32, hillsize=32)\n",
     "\n",
     "fig, (ax1, ax2, ax3, ax4, ax5, ax6) = plt.subplots(1, 6, figsize=(14,4))\n",
     "im1 = ax1.imshow(dem1, cmap='terrain')\n",
@@ -86,8 +86,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "dem1 = topo.GridObject.gen_random_bool()\n",
-    "dem2 = topo.GridObject.gen_random_bool()\n",
+    "dem1 = topo.gen_random_bool()\n",
+    "dem2 = topo.gen_random_bool()\n",
     "\n",
     "fig, (ax1, ax2, ax3, ax4, ax5) = plt.subplots(1, 5, figsize=(12,4))\n",
     "im1 = ax1.imshow(dem1, cmap='binary')\n",
@@ -118,8 +118,8 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "dem1 = topo.GridObject.gen_random(rows=32, columns=32, hillsize=32)\n",
-    "dem2 = topo.GridObject.gen_random(rows=32, columns=32, hillsize=16)\n",
+    "dem1 = topo.gen_random(rows=32, columns=32, hillsize=32)\n",
+    "dem2 = topo.gen_random(rows=32, columns=32, hillsize=16)\n",
     "\n",
     "fig, (ax1, ax2, ax3) = plt.subplots(1, 3)\n",
     "ax1.imshow(dem1, cmap='terrain')\n",

examples/test_GridObject.ipynb

@@ -24,7 +24,7 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "dem = topo.GridObject.gen_random()\n",
+    "dem = topo.gen_random()\n",
     "dem.info()"
    ]
   },

examples/test_genGrid.ipynb

@@ -18,7 +18,7 @@
     "from matplotlib.colors import LightSource\n",
     "\n",
     "# generating Gridobject with random terrain\n",
-    "dem = topo.GridObject.gen_random()\n",
+    "dem = topo.gen_random()\n",
     "\n",
     "# plotting dem with hillshade\n",
     "ls = LightSource(azdeg=270, altdeg=60)\n",

src/topotoolbox/__init__.py

@@ -1,2 +1,2 @@
-from .grid_object import GridObject
+from .grid_object import *
 from .utils import *