Metadata-Version: 2.1
Name: xdem
Version: 0.0.2.post1
Summary: Set of tools to manipulate Digital Elevation Models (DEMs) 
Home-page: https://github.com/GlacioHack/xdem
Author: The GlacioHack Team
Author-email: john@doe.com
License: BSD-3
Description: # xdem
        Set of tools to manipulate Digital Elevation Models (DEMs)
        
        More documentation to come!
        
        [![Documentation Status](https://readthedocs.org/projects/xdem/badge/?version=latest)](https://xdem.readthedocs.io/en/latest/?badge=latest)
        [![build](https://github.com/GlacioHack/xdem/actions/workflows/python-package.yml/badge.svg)](https://github.com/GlacioHack/xdem/actions/workflows/python-package.yml)
        
        
        ## Installation ##
        
        ```
        $ git clone https://github.com/GlacioHack/xdem.git
        $ cd ./xdem
        $ conda env create -f environment.yml
        $ conda activate xdem
        $ pip install .
        ```
        or
        ```bash
        pip install git+https://github.com/GlacioHack/xdem.git
        ```
        
        To update, please use the `--force-reinstall` flag for `conda` or `pip` to ensure the latest version is installed (`geoutils` and `xdem` do not yet have proper release schedules as of 2021-05-13).
        
        ## Structure 
        
        xdem are for now composed of three libraries:
        - `coreg.py` with tools covering differet aspects of DEM coregistration
        - `spatial_tools.py` for spatial operations on DEMs
        - `dem.py` for DEM-specific operations, such as vertical datum correction.
        
        ## How to contribute
        
        You can find ways to improve the libraries in the [issues](https://github.com/GlacioHack/xdem/issues) section. All contributions are welcome.
        To avoid conflicts, it is suggested to use separate branches for each implementation. All changes must then be submitted to the dev branch using pull requests. Each PR must be reviewed by at least one other person.
        
        ### Documentation
        See the documentation at https://xdem.readthedocs.io
        
        ### Testing - again please read!
        These tools are only valuable if we can rely on them to perform exactly as we expect. So, we need testing. Please create tests for every function that you make, as much as you are able. Guidance/examples here for the moment: https://github.com/GeoUtils/georaster/blob/master/test/test_georaster.py
        https://github.com/corteva/rioxarray/blob/master/test/integration/test_integration__io.py
        
        
        
        ### Examples
        
        **Coregister a DEM to another DEM**
        ```python
        import xdem
        
        reference_dem = xdem.DEM("path/to/reference.tif")
        dem_to_be_aligned = xdem.DEM("path/to/dem.tif")
        
        nuth_kaab = xdem.coreg.NuthKaab()
        
        nuth_kaab.fit(reference_dem.data, dem_to_be_aligned.data, transform=reference_dem.transform)
        
        
        aligned_dem = xdem.DEM.from_array(
        	nuth_kaab.apply(dem_to_be_aligned.data, transform=dem_to_be_aligned.transform),
        	transform=dem_to_be_aligned.transform,
        	crs=dem_to_be_aligned.crs
        )
        
        aligned_dem.save("path/to/coreg.tif")
        ```
        This is an implementation of the [Nuth and Kääb (2011)](https://doi.org/10.5194/tc-5-271-2011) approach.
        [Please see the documentation](https://xdem.readthedocs.io/en/latest/coregistration.html) for more approaches.
        
        **Subtract one DEM with another**
        ```python
        import xdem
        
        first_dem = "path/to/first.tif"
        second_dem = "path/to/second.tif"
        
        difference = xdem.spatial_tools.subtract_rasters(first_dem, second_dem)
        
        difference.save("path/to/difference.tif")
        ```
        By default, `second_dem` is reprojected to fit `first_dem`.
        This can be switched with the keyword argument `reference="second"`.
        The resampling method can also be changed (e.g. `resampling_method="nearest"`) from the default `"cubic_spline"`.
        
        
Platform: UNKNOWN
Description-Content-Type: text/markdown
Provides-Extra: rioxarray
Provides-Extra: richdem
Provides-Extra: pdal
Provides-Extra: opencv
Provides-Extra: pytransform3d
