docs(gis module): docstring tweaks; add to api documentation #341
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| # Based on github template: https://github.com/actions/starter-workflows/blob/main/ci/python-package.yml | |
| name: Tests | |
| on: | |
| schedule: | |
| - cron: '0 9 * * 1' # run every Monday at 9 AM UTC (3 am PST) | |
| push: | |
| branches: | |
| - '**' | |
| tags-ignore: | |
| - '*.*' | |
| pull_request: | |
| workflow_dispatch: | |
| jobs: | |
| build: | |
| name: ${{ matrix.python-version }}, ${{ matrix.os }} | |
| runs-on: ${{ matrix.os }} | |
| strategy: | |
| fail-fast: false | |
| matrix: | |
| os: [ ubuntu-latest, macos-latest, windows-latest ] | |
| python-version: ['3.12', '3.11', '3.10'] # ['3.8', '3.x'] | |
| exclude: | |
| # tests with ubuntu-latest, python latest | |
| # are executed by build_docs.yaml | |
| - os: ubuntu-latest | |
| python-version: 3.12 | |
| steps: | |
| - name: Checkout source | |
| uses: actions/checkout@v4 | |
| with: | |
| persist-credentials: false | |
| - name: Fetch all Git tags | |
| run: git fetch --prune --unshallow --tags | |
| - name: Setup Micromamba | |
| uses: mamba-org/setup-micromamba@v1 | |
| with: | |
| environment-file: ci/test_environment.yml | |
| cache-environment: true | |
| cache-downloads: true | |
| create-args: >- | |
| python=${{ matrix.python-version }} | |
| init-shell: >- | |
| bash | |
| powershell | |
| - name: Conda info | |
| shell: bash -l {0} | |
| run: micromamba info | |
| - name: Install dependencies | |
| shell: bash -l {0} | |
| run: | | |
| if [[ ! -d "$HOME/.local/bin" ]]; then | |
| mkdir -p "$HOME/.local/bin"; | |
| fi | |
| # copy modflow bins to local dir to add to PATH later | |
| if [ "$RUNNER_OS" == "Windows" ]; then | |
| d="win" | |
| elif [ "$RUNNER_OS" == "macOS" ]; then | |
| d="mac" | |
| elif [ "$RUNNER_OS" == "Linux" ]; then | |
| d="linux" | |
| else | |
| d="unexpectedos" | |
| exit 1 | |
| fi | |
| echo bin/$d/. >> $GITHUB_PATH | |
| echo $GITHUB_PATH | |
| - name: Test install from git | |
| shell: bash -l {0} | |
| run: | | |
| pip install git+https://github.com/doi-usgs/sfrmaker@develop | |
| cd .. | |
| python -c "import sfrmaker" | |
| cd sfrmaker | |
| - name: Install SFRmaker and ipykernel | |
| shell: bash -l {0} | |
| run: | | |
| pip install -e . | |
| python -m ipykernel install --user --name sfrmaker_ci --display-name "sfrmaker_ci" | |
| - name: Test with latest PyPI flopy | |
| shell: bash -l {0} | |
| if: ${{ matrix.python-version == 3.11}} | |
| run: pip install flopy --force-reinstall | |
| - name: Conda list | |
| shell: bash -l {0} | |
| run: | | |
| micromamba list | |
| pip list | |
| #- name: Lint with flake8 | |
| # run: | | |
| # # stop the build if there are Python syntax errors or undefined names | |
| # flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics | |
| # # exit-zero treats all errors as warnings. The GitHub editor is 127 chars wide | |
| # flake8 . --count --exit-zero --max-complexity=10 --max-line-length=127 --statistics | |
| - name: Run tests and upload coverage | |
| shell: bash -l {0} | |
| timeout-minutes: 60 | |
| run: | | |
| coverage run -m pytest -v --durations=20 --timeout=120 | |
| - name: Upload coverage | |
| shell: bash -l {0} | |
| run: | | |
| coverage report -m | |
| codecov |