Merge pull request #1 from iHeadWater/dev

Dev

.editorconfig

@@ -0,0 +1,21 @@
+# http://editorconfig.org
+
+root = true
+
+[*]
+indent_style = space
+indent_size = 4
+trim_trailing_whitespace = true
+insert_final_newline = true
+charset = utf-8
+end_of_line = lf
+
+[*.bat]
+indent_style = tab
+end_of_line = crlf
+
+[LICENSE]
+insert_final_newline = false
+
+[Makefile]
+indent_style = tab

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,25 @@
+---
+name: Bug Report
+about: Create a bug report to help us improve
+labels: bug
+---
+
+<!-- Please search existing issues to avoid creating duplicates. -->
+
+### Environment Information
+
+-   hydromodel version:
+-   Python version:
+-   Operating System:
+
+### Description
+
+Describe what you were trying to get done.
+Tell us what happened, what went wrong, and what you expected to happen.
+
+### What I Did
+
+```
+Paste the command(s) you ran and the output.
+If there was a crash, please include the traceback here.
+```

.github/ISSUE_TEMPLATE/config.yml

@@ -0,0 +1,10 @@
+contact_links:
+    - name: Ask questions
+      url: https://github.com/OuyangWenyu/hydro-model-xaj/discussions/categories/q-a
+      about: Please ask and answer questions here.
+    - name: Ideas
+      url: https://github.com/OuyangWenyu/hydro-model-xaj/discussions/categories/ideas
+      about: Please share your ideas here.
+    - name: Ask questions from the GIS community
+      url: https://gis.stackexchange.com
+      about: To get answers from questions in the GIS community, please ask and answer questions here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,18 @@
+---
+name: Feature Request
+about: Submit a feature request to help us improve
+labels: Feature Request
+---
+
+<!-- Please search existing issues to avoid creating duplicates. -->
+
+### Description
+
+Describe the feature (e.g., new functions/tutorials) you would like to propose.
+Tell us what can be achieved with this new feature and what's the expected outcome.
+
+### Source code
+
+```
+Paste your source code here if have sample code to share.
+```

.github/workflows/docs-build.yml

@@ -0,0 +1,51 @@
+name: docs-build
+on:
+    pull_request:
+        branches:
+            - master
+
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+              with:
+                  fetch-depth: 0
+            - uses: actions/setup-python@v4
+              with:
+                  python-version: "3.10"
+            - name: Install GDAL
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install --find-links=https://girder.github.io/large_image_wheels --no-cache GDAL pyproj
+            - name: Test GDAL installation
+              run: |
+                  python -c "from osgeo import gdal"
+                  gdalinfo --version
+            - name: Install dependencies
+              run: |
+                  pip install --no-cache-dir Cython
+                  pip install -r requirements.txt -r requirements_dev.txt  -r requirements_docs.txt
+                  pip install .
+            - name: Discover typos with codespell
+              run: codespell --skip="*.csv,*.geojson,*.json,*.js,*.html,*cff,*.pdf,./.git" --ignore-words-list="aci,acount,acounts,fallow,hart,hist,nd,ned,ois,wqs"
+            - name: PKG-TEST
+              run: |
+                  python -m unittest discover tests/
+            - name: Build docs
+              run: |
+                  mkdocs build
+            # - name: Deploy to Netlify
+            #   uses: nwtgck/actions-netlify@v2.0
+            #   with:
+            #       publish-dir: "./site"
+            #       production-branch: master
+            #       github-token: ${{ secrets.GITHUB_TOKEN }}
+            #       deploy-message: "Deploy from GitHub Actions"
+            #       enable-pull-request-comment: true
+            #       enable-commit-comment: false
+            #       overwrites-pull-request-comment: true
+            #   env:
+            #       NETLIFY_AUTH_TOKEN: ${{ secrets.NETLIFY_AUTH_TOKEN }}
+            #       NETLIFY_SITE_ID: ${{ secrets.NETLIFY_SITE_ID }}
+            #   timeout-minutes: 10

.github/workflows/docs.yml

@@ -0,0 +1,28 @@
+name: docs
+on:
+    push:
+        branches:
+            - master
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+        steps:
+            - uses: actions/checkout@v3
+            - uses: actions/setup-python@v4
+              with:
+                  python-version: 3.9
+            - name: Install dependencies
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install --user --no-cache-dir Cython
+                  pip install --user -r requirements.txt
+                  pip install .
+            - name: Discover typos with codespell
+              run: |
+                  pip install codespell
+                  codespell --skip="*.csv,*.geojson,*.json,*.js,*.html,*cff,./.git" --ignore-words-list="aci,acount,acounts,fallow,hart,hist,nd,ned,ois,wqs,watermask"
+            - name: PKG-TEST
+              run: |
+                  python -m unittest discover tests/
+            - run: pip install -r requirements_docs.txt
+            - run: mkdocs gh-deploy --force

.github/workflows/macos.yml

@@ -0,0 +1,38 @@
+on:
+    push:
+        branches:
+            - master
+    pull_request:
+        branches:
+            - master
+
+name: macOS build
+jobs:
+    test-macOS:
+        runs-on: ${{ matrix.os }}
+        name: ${{ matrix.os }} (${{ matrix.python-version}})
+        strategy:
+            fail-fast: false
+            matrix:
+              os: ["macOS-latest"]
+              python-version: ["3.10"]
+        steps:
+          - name: Checkout code
+            uses: actions/checkout@v3
+
+          - name: Set up Python
+            uses: actions/setup-python@v4
+            with:
+              python-version: ${{ matrix.python-version}}
+          - name: Install GDAL
+            run: |
+              brew install gdal
+          - name: Test GDAL installation
+            run: |
+              gdalinfo --version
+          - name: Install dependencies
+            run: |
+                python -m pip install --upgrade pip
+                pip install --no-cache-dir Cython
+                pip install -r requirements.txt
+                pip install .

.github/workflows/pypi.yml

@@ -0,0 +1,30 @@
+# This workflows will upload a Python Package using Twine when a release is created
+# For more information see: https://help.github.com/en/actions/language-and-framework-guides/using-python-with-github-actions#publishing-to-package-registries
+
+name: pypi
+
+on:
+    release:
+        types: [created]
+
+jobs:
+    deploy:
+        runs-on: ubuntu-latest
+
+        steps:
+            - uses: actions/checkout@v3
+            - name: Set up Python
+              uses: actions/setup-python@v4
+              with:
+                  python-version: "3.x"
+            - name: Install dependencies
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install setuptools wheel twine
+            - name: Build and publish
+              env:
+                  TWINE_USERNAME: ${{ secrets.PYPI_USERS }}
+                  TWINE_PASSWORD: ${{ secrets.PYPI_PASSWORD }}
+              run: |
+                  python setup.py sdist bdist_wheel
+                  twine upload dist/*

.github/workflows/ubuntu.yml

@@ -0,0 +1,48 @@
+on:
+    push:
+        branches:
+            - master
+            - dev
+    pull_request:
+        branches:
+            - master
+            - dev
+
+name: Linux build
+jobs:
+    py-check:
+        runs-on: ${{ matrix.config.os }}
+        name: ${{ matrix.config.os }} (${{ matrix.config.py }})
+        strategy:
+            fail-fast: false
+            matrix:
+                config:
+                    - { os: ubuntu-latest, py: "3.8" }
+                    - { os: ubuntu-latest, py: "3.9" }
+                    - { os: ubuntu-latest, py: "3.10" }
+                    - { os: ubuntu-latest, py: "3.11" }
+        steps:
+            - name: Checkout Code
+              uses: actions/checkout@v3
+            - name: Setup Python
+              uses: actions/setup-python@v4
+              with:
+                  python-version: ${{ matrix.config.py }}
+            - name: Install GDAL
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install --no-cache-dir Cython
+                  pip install --find-links=https://girder.github.io/large_image_wheels --no-cache GDAL
+            - name: Test GDAL installation
+              run: |
+                  python -c "from osgeo import gdal"
+                  gdalinfo --version
+            - name: Install dependencies
+              run: |
+                  pip install --user -r requirements.txt
+                  pip install --user -r requirements_dev.txt
+                  pip install .
+            - name: PKG-TEST
+              run: |
+                  python -m unittest discover tests/
+

.github/workflows/windows.yml

@@ -0,0 +1,33 @@
+on:
+    push:
+        branches:
+            - master
+            - dev
+    pull_request:
+        branches:
+            - master
+            - dev
+
+name: Windows build
+jobs:
+    test-windows:
+        runs-on: windows-latest
+        steps:
+            - uses: actions/checkout@v3
+            - name: Install miniconda
+              uses: conda-incubator/setup-miniconda@v2
+              with:
+                  auto-activate-base: true
+                  python-version: "3.10"
+            - name: Install GDAL
+              run: conda install -c conda-forge gdal --yes
+            - name: Test GDAL installation
+              run: |
+                  python -c "from osgeo import gdal"
+                  gdalinfo --version
+            - name: Install dependencies
+              run: |
+                  python -m pip install --upgrade pip
+                  pip install --no-cache-dir Cython
+                  pip install -r requirements.txt
+                  pip install .

AUTHORS.rst

@@ -0,0 +1,13 @@
+=======
+Credits
+=======
+
+Development Lead
+----------------
+
+* Wenyu Ouyang <wenyuouyang@outlook.com>
+
+Contributors
+------------
+
+None yet. Why not be the first?

MANIFEST.in

@@ -1 +1,7 @@
-recursive-include XXX *.csv *.txt # 打包需包含csv、txt为后缀的文件；XXX为包名
+include LICENSE
+include README.md
+include requirements.txt
+
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]
+

environment-dev.yml

@@ -13,9 +13,18 @@ dependencies:
   - spotpy=1.5.14
   - seaborn
   - tqdm
+  - yaml
+  - bmipy
+  # for dev 
   - sphinx
   - pytest
   - black
+  - flake8
+  # pip
   - pip
   - pip:
+    - setuptools
+    - wheel
+    - twine
+    - bump2version
     - hydrodataset