Package re-structuring and updated docs (#4)

* Quotation marks removed

* Reporting update

* Restart

* Actions set up

* rasterio install added

* docs updated

* docs structure updated

* conf file location corrected

* Documentation added

* Merge functionality updated

* Unittesting added

* test script and running added

* Statistics analysis added

* autodoc modules edited

* autodoc dir moved

* module dir changed

* Docs quickstart re-run

* docs dir edited

* markdown enabled

.github/workflows/pypi-publish.yml

@@ -0,0 +1,39 @@
+# This workflow will upload a Python Package using Twine when a release is created
+# For more information see: https://docs.github.com/en/actions/automating-builds-and-tests/building-and-testing-python#publishing-to-package-registries
+
+# This workflow uses actions that are not certified by GitHub.
+# They are provided by a third-party and are governed by
+# separate terms of service, privacy policy, and support
+# documentation.
+
+name: Upload Python Package
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  deploy:
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v3
+    - name: Set up Python
+      uses: actions/setup-python@v3
+      with:
+        python-version: '3.x'
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install build
+    - name: Build package
+      run: python -m build --sdist --wheel --outdir dist/
+    - name: Publish package
+      uses: pypa/gh-action-pypi-publish@27b31702a0e7fc50959f5ad993c78deac1bdfc29
+      with:
+        user: __token__
+        password: ${{ secrets.PYPI_TOKEN }}

.github/workflows/unit_test.yml

@@ -0,0 +1,33 @@
+on:
+  pull_request:
+    types: [opened, reopened, synchronize, edited]
+  workflow_dispatch:
+
+jobs:
+  build:
+    name: unit_test
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        python-version: ['3.8','3.9','3.10']
+    steps:
+      - name: Install Python
+        uses: actions/setup-python@v4
+        with:
+          python-version: "3.x"        
+      - name: Checkout repo
+        uses: actions/checkout@v3
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+      - name: Install dependencies
+        shell: bash
+        run: |
+          python3 -m pip install --upgrade pip
+          python3 -m pip install Bottleneck 
+          python3 -m pip install --upgrade setuptools
+          cd $GITHUB_WORKSPACE
+          pip install . 
+      - name: Run unit tests
+        shell: bash
+        run: |
+          python3 -m unittest discover griml

.gitignore

@@ -1,24 +1,9 @@
-
 *.tif
 other/out/*
 other/datasets/*
 other/old/*
-src/examples/getHagenBrae.py
-src/examples/analyse.py
-src/examples/getHagenBrae_dask.py
-src/examples/getMargin.py
-src/examples/getMarginGIMP.py
-src/examples/getTimeSeries.py
-src/examples/margin.py
-src/examples/process_old.py
-src/examples/sar_water.py
-*.docx
-src/griml/examples/analyse.py
-src/griml/examples/getHagenBrae.py
-src/griml/examples/getHagenBrae_dask.py
-src/griml/examples/getMargin.py
-src/griml/examples/getMarginGIMP.py
-src/griml/examples/getTimeSeries.py
-src/griml/examples/margin.py
-src/griml/examples/process_old.py
-src/griml/examples/sar_water.py
+other/iml_2017/*
+other/hagen_brae/*
+other/lake_temperature/*
+other/south_greenland/*
+src/griml/examples/*

.readthedocs.yaml

@@ -0,0 +1,26 @@
+# .readthedocs.yaml
+# Read the Docs configuration file
+# See https://docs.readthedocs.io/en/stable/config-file/v2.html for details
+
+# Required
+version: 2
+
+# Set the version of Python and other tools you might need
+build:
+  os: ubuntu-22.04
+  tools:
+    python: "3.8"
+
+# Build documentation in the docs/ directory with Sphinx
+sphinx:
+  configuration: docs/conf.py
+
+# We recommend specifying your dependencies to enable reproducible builds:
+# https://docs.readthedocs.io/en/stable/guides/reproducible-builds.html
+python:
+  install:
+  - requirements: docs/requirements.txt
+
+formats:
+  - pdf
+  - epub

docs/Makefile

@@ -5,8 +5,8 @@
 # from the environment for the first two.
 SPHINXOPTS    ?=
 SPHINXBUILD   ?= sphinx-build
-SOURCEDIR     = source
-BUILDDIR      = build
+SOURCEDIR     = .
+BUILDDIR      = _build
 
 # Put it first so that "make" without argument is like "make help".
 help: