xarray-spatial 0.3.5__tar.gz → 0.3.7__tar.gz

xarray-spatial-0.3.7/.gitattributes

@@ -0,0 +1,2 @@
+__init__.py export-subst
+setup.py export-subst

xarray-spatial-0.3.7/.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,31 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: bug
+assignees: ''
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Desktop (please complete the following information):**
+ - OS: [e.g. iOS]
+ - Browser [e.g. chrome, safari]
+ - Version [e.g. 22]
+
+**Smartphone (please complete the following information):**
+ - Device: [e.g. iPhone6]
+ - OS: [e.g. iOS8.1]
+ - Browser [e.g. stock browser, safari]
+ - Version [e.g. 22]
+
+**Additional context**
+Add any other context about the problem here.

xarray-spatial-0.3.7/.github/ISSUE_TEMPLATE/feature-proposal.md

@@ -0,0 +1,33 @@
+---
+name: Feature proposal
+about: Suggest an idea
+title: ''
+labels: proposal
+assignees: ''
+
+---
+
+**Author of Proposal:**
+## Reason or Problem
+Describe what the need for this new feature is or what problem this new feature will address.
+## Proposal
+Description of the new feature, how it will be used, what it will fix, etc. 
+
+**Design:**
+Include description of this feature's design with enough detail for those who are familiar enough with this project to understand the feature and how it could be implmented. This section should get into specifics of how the feature will be designed and implemented. 
+
+**Usage:** 
+Detailed instructions for this feature's use. 
+
+**Value:** What value does the implementation of this new feature bring to xarray-spatial.
+## Stakeholders and Impacts
+Who are the stakeholders in this update? Will you be implementing this new feature or will someone else? What is the potential impact of implementing this new feature? Specifically, what are some other components would be impacted? 
+## Drawbacks
+What are potential reasons why this feature should not be implemented?
+## Alternatives
+Describe other solutions or features you have considered when coming up with this proposal.
+
+## Unresolved Questions
+What are parts of this feature's design that are undecided.
+## Additional Notes or Context
+Anything elses that is important to know for the implementation of this new feature.

xarray-spatial-0.3.7/.github/pull_request_template.md

@@ -0,0 +1,7 @@
+Fixes #
+
+## Proposed Changes
+
+  -
+  -
+  -

xarray-spatial-0.3.7/.github/workflows/codecov.yml

@@ -0,0 +1,38 @@
+name: Codecov
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+    - '*'
+
+jobs:
+  run:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ubuntu-latest]
+        python: [3.9]
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: ${{ matrix.python }}
+    steps:
+    - uses: actions/checkout@master
+    - name: Setup Python
+      uses: actions/setup-python@master
+      with:
+        python-version: ${{ matrix.python }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[tests]
+    - name: Generate coverage report
+      run: |
+        NUMBA_DISABLE_JIT=1 pytest --cov=./ --cov-report=xml --ignore ./xrspatial/tests/test_polygonize.py
+    - name: Upload coverage to Codecov
+      uses: codecov/codecov-action@v2
+      with:
+        env_vars: OS,PYTHON
+        fail_ci_if_error: true
+        verbose: true

xarray-spatial-0.3.7/.github/workflows/docs-publish.yml

@@ -0,0 +1,32 @@
+name: Upload Docs To Azure Blob Storage
+
+on:
+  release:
+    types: [published]
+  workflow_dispatch:
+
+jobs:
+  upload:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v1
+      - uses: actions/setup-dotnet@v1
+        with:
+          dotnet-version: '3.0.100'
+      - name: Install dependencies
+        run: |
+          sudo apt-get -y install pandoc
+          python -m pip install --upgrade pip
+      - name: Install xarray-spatial
+        run: |
+          pip install .[doc,tests]
+          pip list
+      - name: Build docs
+        run: |
+          make -C docs html
+      - uses: lauchacarro/Azure-Storage-Action@v1.0
+        with:
+          enabled-static-website: 'true'
+          folder: 'docs/build/html'
+          index-document: 'index.html'
+          connection-string: ${{ secrets.CONNECTION_STRING }}

xarray-spatial-0.3.7/.github/workflows/pypi-publish.yml

@@ -0,0 +1,45 @@
+name: Publish package to PyPI
+on:
+  push:
+    tags:
+       - '*'
+jobs:
+  publish:
+    runs-on: ubuntu-20.04
+    steps:
+      - uses: actions/checkout@master
+      - name: Set up Python 3.9
+        uses: actions/setup-python@v1
+        with:
+          python-version: 3.9
+      - name: Get release version
+        run: |
+          echo "CHANGELOG_VERSION=$(cat CHANGELOG.md | grep -oP '(?<=###\s)(.*)(?=\s\-)' | head -n 1 | sed 's/Version\s/v/')" >> $GITHUB_ENV
+          echo "TAG_VERSION=`echo $(git describe --tags --abbrev=0)`" >> $GITHUB_ENV
+      - name: Check changelog release version
+        if: ${{ env.TAG_VERSION != env.CHANGELOG_VERSION }}
+        run: |
+          echo "CHANGELOG_VERSION($CHANGELOG_VERSION) is different from TAG_VERSION($TAG_VERSION)"
+          exit 1
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install build
+      - name: Get all git tags
+        run: git fetch --tags -f
+      - name: Build package
+        run: |
+          python -m build --sdist --wheel
+      - name: Get package size
+        run: echo "PKG_SIZE=$(find dist -maxdepth 1 -regex '.*gz' | xargs stat --format='%s')" >> $GITHUB_ENV
+      - name: Check package size
+        if: ${{ env.PKG_SIZE > 1e+8 }}
+        run: |
+          echo "PKG_SIZE($PKG_SIZE bytes) is greater than 100MB"
+          exit 1
+      - name: Publish package
+        if: startsWith(github.ref, 'refs/tags')
+        uses: pypa/gh-action-pypi-publish@master
+        with:
+          skip_existing: true
+          password: ${{ secrets.PYPI_API_TOKEN }}

xarray-spatial-0.3.7/.github/workflows/test.yml

@@ -0,0 +1,31 @@
+name: pytest
+on:
+  push:
+    branches:
+      - master
+  pull_request:
+    branches:
+    - '*'
+
+jobs:
+  run:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: ['ubuntu-latest', 'macos-latest', 'windows-latest']
+        python: [3.7, 3.8, 3.9, '3.10', 3.11]
+    env:
+      OS: ${{ matrix.os }}
+      PYTHON: ${{ matrix.python }}
+    steps:
+    - uses: actions/checkout@master
+    - name: Setup Python
+      uses: actions/setup-python@master
+      with:
+        python-version: ${{ matrix.python }}
+    - name: Install dependencies
+      run: |
+        python -m pip install --upgrade pip
+        pip install -e .[tests]
+    - name: Run pytest
+      run: pytest

xarray-spatial-0.3.7/.gitignore

@@ -0,0 +1,96 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+pip-wheel-metadata/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+xrspatial/.version
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+
+# Translations
+*.mo
+*.pot
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+.python-version
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+.DS_Store
+/test_tiles_output
+*.TIF*
+
+# airspeed velocity
+.asv/

xarray-spatial-0.3.7/CHANGELOG.md

@@ -0,0 +1,352 @@
+## Xarray-Spatial Changelog
+-----------
+
+### Version 0.3.7 - 2023-06-05
+The 0.3.7 release is a hot fix for 0.3.6, which has problem with publishing to PyPi
+as the package exceeds the limit of 100MB. In this new release, example notebooks are
+cleaned up to reduce the package size.
+
+#### Enhancements
+- clear example notebook outputs (#786)
+
+### Version 0.3.6 - 2023-06-02
+With the 0.3.6 release, xarray-spatial now supports python 3.11.
+This release focuses on demonstrating the reliability of the library by adding more tests
+against GDAL/QGIS. 
+
+#### Enhancements
+- Test on Python 3.11 (#750)
+- Pin numpy version (#780)
+- zonal stats (#764)
+- updated citation (#769)
+- classify.binary: handle NaNs and infinite values (#763)
+- Test against QGIS, GDAL (#744)
+- Zonal crosstab user guide notebook enhancement (#759)
+- cpu_bin with binary search (#760)
+- outline for housing price feature engineering nb (#725)
+- More examples to user guide (#742)
+- Use setuptools (#749)
+- Update contributor badge (#740)
+- update pharmacy desserts notebook (#723)
+- Update README.md (#719)
+- viewshed gpu notebook (#720)
+- Fixed feature-proposal.md config (#718)
+
+#### Bug Fixes
+- correct docs for proximity (#778)
+- Zonal_crosstab 3D: Ensure content of input param `values` is preserved (#754)
+- Multispectral tools: convert data to float32 dtype before doing calculations (#755)
+
+
+### Version 0.3.5 - 2022-06-05
+The 0.3.5 release mainly addresses the scaling issue in GPU viewshed to gain better accurate triangulation.
+The GPU raytraced viewshed should now give comparable results to the CPU version.
+However, the 2 versions use 2 different approaches, there can be slightly differences at some points
+where a version returns visible while the other considers them as invisible.
+
+#### Enhancements
+- command to get change log (#716)
+- Added Feature Proposal Template (#714)
+
+#### Bug Fixes
+- Improved viewshed rtx. Now result should match the CPU version (#715)
+
+### Version 0.3.4 - 2022-06-01
+The 0.3.4 release primarily a bug fix release but also includes a number of enhancements with a focus on GPU supports.
+
+#### Enhancements
+- NumPy zonal stats: return a data array of calculated stats (#685)
+- set unit for hotspots output (#686)
+- More robust cuda and cupy identification (#657)
+- Remove deprecated tiles module (#698)
+- Test on python 3.10, remove 3.6 (#694)
+- moved all tests to github actions (#689)
+- Add isort to pytest (#700)
+- Add flake8 to pytest (#697)
+- Remove unnecessary executable flags (#696)
+- updated test hotspots gpu (#692)
+- 3D numpy zonal_crosstab to support more agg methods (#687)
+
+#### Bug Fixes
+- Fix rtx viewshed rendering blank image (#711)
+- Convolve_2d gpu fixes (#702)
+- focal.mean(): only do data type conversion once (#699)
+- Update to remote sensing notebook (#688)
+- focal_stats(): gpu case (#709)
+- focal apply: drop gpu support (#706)
+- drop gpu support (#705)
+- enabled numba.cuda.jit in hotspots cupy (#691)
+
+#### Documentation
+- Correct examples in docstrings (#703)
+- Fix doc build dependencies in CI (#683)
+- Fix link to Austin road network notebook (#695)
+
+### Version 0.3.3 - 2022-03-21
+- fixed ubuntu version (#681)
+- Don't calculate angle when not needed (#677)
+- codecov: ignore all tests at once (#674)
+- add more tests to focal module (#676)
+- classify: more tests (#675)
+- Codecov: disable Numba; ignore tests, experimental, and gpu_rtx (#673)
+- Improve linter: add isort (#672)
+- removed stale test files from project root (#670)
+- User guide fixes (#665)
+- license year in README to include 2022 (#668)
+- install dependencies specified in test config (#666)
+- Pytests for CuPy zonal stats (#658)
+- add Codecov badge to README
+- codecov with github action (#663)
+- Modernise build system (#654)
+- classify tools: classify infinite values as nans, natural_breaks: classify all data points when using sub sample (#653)
+- Add more benchmarks (#648)
+- Stubbed out function for Analytics module (#621)
+- Fix doc build failure due to Jinja2 version (#651)
+
+### Version 0.3.2 - 2022-02-04
+- Remove numpy version pin (#637)
+- aspect: added benchmarks (#640)
+- Clean gitignore and manifest files (#642)
+- Benchmark results (#643)
+- handle CLI errors #442 (#644)
+- Cupy zonal (#639)
+- Tests improvements (#636)
+
+### Version 0.3.1 - 2022-01-10
+- Add benchmarking framework using asv (#595)
+- Fix classify bug with dask array (#599)
+- polygonize function on cpu for numpy-backed xarray DataArrays (#585)
+- Test python 3.9 on CI (#602)
+- crosstab: speedup dask case (#596)
+- Add benchmark for CPU polygonize (#605)
+- Change copyright year to include 2021 (#610)
+- Docs enhancement (#604, #628)
+- code refactor: use array function mapper, add messages param to not_implemented_func() (#612)
+- condense tests (#613)
+- Multispectral fixes (#617)
+- Change copyright year to 2022 (#622)
+- Aspect: convert to float if int dtype input raster (#619)
+- direction(), allocation(): set all NaNs at initalization (#618)
+- Add rtx gpu hillshade with shadows (#608)
+- Add hillshade benchmarking, for numpy, cupy and rtxpy (#625)
+- Focal mean: handle nans inside kernel (#623)
+- Convert to float32 if input raster is in int dtype (#629)
+
+### Version 0.3.0 - 2021-12-01
+- Added a pure numba hillshade that is 10x faster compared to numpy (#542)
+- dask case proximity: process whole raster at once if max_distance exceed max possible distance (#558)
+- pathfinding: `start` and `goal` in (y, x) format (#550)
+- generate_terrain: cupy case, dask numpy case (#555)
+- Optimize natural_break on large inputs (#562)
+- Fixes in CPU version of natural_breaks. (#562) (#563)
+- zonal stats, speed up numpy case (#568)
+- Ensure that cupy is not None (#570)
+- Use explicit cupy to numpy conversion in tests (#573)
+- zonal stats: speed up dask case (#572)
+- zonal_stats: ensure chunksizes of zones and values are matching (#574)
+- validate_arrays: ensure chunksizes of arrays are matching (#577)
+- set default value for num_sample (#580)
+- Add rtx gpu viewshed and improve cpu viewshed (#588)
+
+### Version 0.2.9 - 2021-09-01
+- Refactored proximity module to avoid rechunking (#549)
+
+### Version 0.2.8 - 2021-08-27
+- Added dask support to proximity tools (#540)
+- Refactored the resample utils function and changed their name to canvas_like (#539)
+- Added zone_ids and cat_ids param to stats zonal function (#538)
+
+### Version 0.2.7 - 2021-07-30
+- Added Dask support for stats and crosstab zonal functions (#502)
+- Ignored NaN values on classify functions (#534)
+- Added agg param to crosstab zonal function (#536)
+
+### Version 0.2.6 - 2021-06-28
+- Updated the classification notebook (#489)
+- Added xrspatial logo to readme (#492)
+- Removed reprojection notebook old version (#494)
+- Added true_color function to documentation (#494)
+- Added th params to true_color function (#494)
+- Added pathfinding nb data load guidance (#491)
+
+### Version 0.2.5 - 2021-06-24
+- Added reprojection notebook (#474)
+- Reviewed local tools notebook (#466)
+- Removed save_cogs_azure notebook (#478)
+- Removed xrspatial install guidance from makepath channel (#483)
+- Moved local notebook to user guide folder (#486)
+- Fixed pharmacy notebook (#479)
+- Fixed path-finding notebook data load guidance (#480)
+- Fixed focal notebook imports (#481)
+- Fixed remote-sensing notebook data load guidance (#482)
+- Added output name and attrs on true_color function (#484)
+- Added classify notebook (#477)
+
+### Version 0.2.4 - 2021-06-10
+- Added resample notebook (#452)
+- Reviewed mosaic notebook (#454)
+- Added local module (#456)
+
+### Version 0.2.3 - 2021-06-02
+- Added make terrain data function (#439)
+- Added focal_stats and convolution_2d functions (#453)
+
+### Version 0.2.2 - 2021-05-07
+- Fixed conda-forge building pipeline
+- Moved all examples data to Azure Storage (#424)
+
+### Version 0.2.1 - 2021-05-06
+- Added GPU and Dask support for Focal tools: mean, apply, hotspots (#238)
+- Moved kernel creation functions to convolution module (#238)
+- Update Code of Conduct (#391)
+- Fixed manhattan distance to sum of abs (#309)
+- Example notebooks running on PC Jupyter Hub (#370)
+- Fixed examples download cli cmd (#349)
+- Removed conda recipe (#397)
+- Updated functions and classes docstrings (#302)
+
+### Version 0.2.0 - 2021-04-28
+- Test release for new github actions
+
+### Version 0.1.9 - 2021-04-27
+- Deprecated tiles module (#381)
+- Added user guide on the documentation website (#376)
+- Updated docs design version mapping (#378)
+- Added Github Action to publish package to PyPI (#371)
+- Moved Spatialpandas to core install requirements for it to work on JLabs (#372)
+- Added CONTRIBUTING.md (#374)
+- Updated `true_color` to return a `xr.DataArray` (#364)
+- Added get_data module and example sentinel-2 data (#358)
+- Added citations guidelines and reformat (#382)
+
+### Version 0.1.8 - 2021-04-15
+- Fixed pypi related error
+
+### Version 0.1.7 - 2021-04-15
+- Updated multispectral.true_color: sigmoid contrast enhancement (#339)
+- Added notebook save cogs in examples directory (#307)
+- Updated Focal user guide (#336)
+- Added documentation step on release steps (#346)
+- Updated cloudless mosaic notebook: use Dask-Gateway (#351)
+- Fixed user guide notebook numbering (#333)
+- Correct warnings (#350)
+- Add flake8 Github Action (#331)
+
+### Version 0.1.6 - 2021-04-12
+- Cleared metadata in all examples ipynb (#327)
+- Moved docs requirements to source folder (#326)
+- Fixed manifest file
+- Fixed travis ci (#323)
+- Included yml files
+- Fixed examples path in Pharmacy Deserts Noteboo
+- Integrate xarray-spatial website with the documentation (#291)
+
+### Version 0.1.5 - 2021-04-08
+- CLI examples bug fixed
+- Added `drop_clouds`, cloud-free mosaic from sentinel2 data example (#255)
+
+### Version 0.1.4 - 2021-04-08
+- Sphinx doc fixes
+- CLI bug fixed in 0.1.5
+
+### Version 0.1.3 - 2021-04-05
+- Added band_to_img utils func
+- Added download-examples CLI command for all notebooks (#241)
+- Added band_to_img utils func
+- Docs enhancements
+- GPU and dask support for multispectral tools
+- GPU and Dask support for classify module (#168)
+- Fixed savi dask cupy test skip
+- Moved validate_arrays to utils
+- Added GPU support for hillshade (#151)
+- Added CLI for examples data
+- Improved Sphinx docs / theme
+
+### Version 0.1.2 - 2020-12-01
+- Added GPU support for curvature (#150)
+- Added dask.Array support for curvature (#150)
+- Added GPU support for aspect (#156)
+- Added dask.Array support for aspect (#156)
+- Added GPU support for slope (#152)
+- Added dask.Array support for slope (#152)
+- Fixed slope cupy: nan edge effect, remove numpy padding that cause TypeError (#160)
+- Fixed aspect cupy: nan edge effect, remove numpy padding that cause TypeError(#160)
+- Updated README with Supported Spatial Features Table
+- Added badge for open source gis timeline
+- Added GPU Support for Multispectral tools (#148)
+- Added Python 3.9 to Test Suite
+
+### Version 0.1.1 - 2020-10-21
+- Added convolution module for use in focal statistics. (#131)
+- Added example notebook for focal statistics and convolution modules.
+
+### Version 0.1.0 - 2020-09-10
+- Moved kernel creation to name-specific functions. (#127)
+- Separated the validate and custom kernel functions. (focal)
+- Added annulus focal kernel (#126) (focal)
+- Added outputting of z-scores from hotspots tool (focal)
+- Changed type checking to use np.floating (focal)
+- Added tests for refactored focal statistics (focal)
+
+### Version 0.0.9 - 2020-08-26
+- Added A* pathfinding
+- Allow all numpy float data types, not just numpy.float64 (#122)
+- Broke out user-guide into individual notebooks  (examples)
+- Added num_sample param option to natural_breaks (#123)
+- Removed sklearn dependency
+
+### Version 0.0.8 - 2020-07-22
+- Fixed missing deps
+
+### Version 0.0.7 - 2020-07-21
+- Added 2D Crosstab (zonal)
+- Added suggest_zonal_canvas (zonal)
+- Added conda-forge build
+- Removed Versioneer
+- Updates to CI/CD
+
+### Version 0.0.6 - 2020-07-14
+- Added Proximity Direction (proximity)
+- Added Proximity Allocation (proximity)
+- Added Zonal Crop (zonal)
+- Added Trim (zonal)
+- Added ebbi (multispectral)
+- Added more tests for slope (slope)
+- Added image grid (readme)
+
+### Version 0.0.5 - 2020-07-05
+- Changed ndvi.py -> multispectral.py
+- Added arvi (multispectral)
+- Added gci (multispectral)
+- Added savi (multispectral)
+- Added evi (multispectral)
+- Added nbr (multispectral)
+- Added sipi (multispectral)
+- Added `count` to default stats (zonal)
+- Added regions tools (zonal)
+
+### Version 0.0.4 - 2020-07-04
+- Test Release
+
+### Version 0.0.3 - 2020-07-04
+- Test Release
+
+### Version 0.0.2 - 2020-06-24
+- Add Pixel-based Region Connectivity Tool (#52)
+- Fixes to Proximity Tools (#45, #37, #36)
+- Changes to slope function to allow for change x, y coordinate fields (#46)
+- Added Pharmacy Desert Example Notebook
+- Add natural breaks classification method
+- Add equal-interval classification method
+- Add quantile classification method
+- Add binary membership classification method
+- Fixes to zonal stats docstring (#40)
+- Added experimental `query layer` from agol-pandas (will probably not be supported long term)
+- Added ReadtheDocs page
+- Added experimental `hotspot` analysis tool (Getis-Ord Gi*) (#27)
+- Added experimental `curvature` analysis tool (Getis-Ord Gi*)
+- Added support for creating WMTS tilesets (moved out of datashader)
+- Added contributor code of conduct
+
+### Version 0.0.1 - 2020-02-15
+- First public release available on GitHub and PyPI.