Skip to content

Commit

Permalink
Linting
Browse files Browse the repository at this point in the history
  • Loading branch information
rhugonnet committed Apr 17, 2023
1 parent eab7c3b commit 597c199
Show file tree
Hide file tree
Showing 2 changed files with 12 additions and 12 deletions.
20 changes: 10 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,17 +16,17 @@

**xDEM** is an open source project to develop a core Python package for the analysis of digital elevation models (DEMs).

It aims at **providing modular and robust tools for the most common analyses needed with DEMs**, including both geospatial
operations specific to DEMs and a wide range of 3D alignment and correction methods from published, peer-reviewed studies.
The core manipulation of DEMs (e.g., vertical alignment, terrain analysis) are **conveniently centered around `DEM` and `dDEM` classes** (that, notably, re-implements all tools
of [gdalDEM](https://gdal.org/programs/gdaldem.html)). More complex pipelines (e.g., 3D rigid coregistration, bias corrections, filtering) are **built around
modular `Coreg`, `BiasCorr` and `Filter` classes that easily interface between themselves**. Finally, xDEM includes advanced
It aims at **providing modular and robust tools for the most common analyses needed with DEMs**, including both geospatial
operations specific to DEMs and a wide range of 3D alignment and correction methods from published, peer-reviewed studies.
The core manipulation of DEMs (e.g., vertical alignment, terrain analysis) are **conveniently centered around `DEM` and `dDEM` classes** (that, notably, re-implements all tools
of [gdalDEM](https://gdal.org/programs/gdaldem.html)). More complex pipelines (e.g., 3D rigid coregistration, bias corrections, filtering) are **built around
modular `Coreg`, `BiasCorr` and `Filter` classes that easily interface between themselves**. Finally, xDEM includes advanced
uncertainty analysis tools based on spatial statistics of [SciKit-GStat](https://scikit-gstat.readthedocs.io/en/latest/).

Additionally, xDEM inherits many convenient functionalities from [GeoUtils](https://github.com/GlacioHack/geoutils) such as
Additionally, xDEM inherits many convenient functionalities from [GeoUtils](https://github.com/GlacioHack/geoutils) such as
**implicit loading**, **numerical interfacing** and **convenient object-based geospatial methods** to easily perform
the most common higher-level tasks needed by geospatial users (e.g., reprojection, cropping, vector masking). Through [GeoUtils](https://github.com/GlacioHack/geoutils), xDEM
relies on [Rasterio](https://github.com/rasterio/rasterio), [GeoPandas](https://github.com/geopandas/geopandas) and [Pyproj](https://github.com/pyproj4/pyproj)
the most common higher-level tasks needed by geospatial users (e.g., reprojection, cropping, vector masking). Through [GeoUtils](https://github.com/GlacioHack/geoutils), xDEM
relies on [Rasterio](https://github.com/rasterio/rasterio), [GeoPandas](https://github.com/geopandas/geopandas) and [Pyproj](https://github.com/pyproj4/pyproj)
for georeferenced calculations, and on [NumPy](https://github.com/numpy/numpy) and [Xarray](https://github.com/pydata/xarray) for numerical analysis. It allows easy access to
the functionalities of these packages through interfacing or composition, and quick inter-operability through object conversion.

Expand All @@ -47,7 +47,7 @@ See [mamba's documentation](https://mamba.readthedocs.io/en/latest/) to install

## Citing methods implemented in the package

When using a method implemented in xDEM, please **cite both the package and the related study**:
When using a method implemented in xDEM, please **cite both the package and the related study**:

Citing xDEM: [![Zenodo](https://zenodo.org/badge/doi/10.5281/zenodo.4809697.svg)](https://zenodo.org/record/4809698)

Expand Down Expand Up @@ -75,4 +75,4 @@ Citing the related study:
2. When ready, submit a pull request from the feature branch of your fork to `GlacioHack/geoutils:main`.
3. The PR will be reviewed by at least one maintainer, discussed, then merged.

More info on [our contributing page](CONTRIBUTING.md).
More info on [our contributing page](CONTRIBUTING.md).
4 changes: 2 additions & 2 deletions tests/test_spatialstats.py
Original file line number Diff line number Diff line change
Expand Up @@ -964,11 +964,11 @@ def test_neff_exact_and_approx_hugonnet(self) -> None:
assert (t1 - t0) < (t2 - t1)

# Check that the approximation function runs with default parameters, sampling 100 out of 250 samples
t3 = time.time()
# t3 = time.time()
neff_approx = xdem.spatialstats.neff_hugonnet_approx(
coords=coords, errors=errors, params_variogram_model=params_variogram_model, subsample=100, random_state=42
)
t4 = time.time()
# t4 = time.time()

# Check that the non-vectorized version gives the same result, sampling 100 out of 250 samples
neff_approx_nv = xdem.spatialstats.neff_hugonnet_approx(
Expand Down

0 comments on commit 597c199

Please sign in to comment.