How to install#
Installing with mamba (recommended)#
mamba install -c conda-forge xdem
Tip
Solving dependencies can take a long time with conda, mamba significantly speeds up the process. Install it with:
conda install mamba -n base -c conda-forge
Once installed, the same commands can be run by simply replacing conda by mamba. More details available in the mamba documentation.
Installing with pip#
pip install xdem
Warning
Updating packages with pip (and sometimes mamba) can break your installation. If this happens, re-create an environment from scratch pinning directly all your other dependencies during initial solve (e.g., mamba create -n xdem-env -c conda-forge xdem myotherpackage==1.0.0).
Installing for contributors#
With mamba#
git clone https://github.com/GlacioHack/xdem.git
mamba env create -f xdem/dev-environment.yml
With pip#
Please note: pip installation is currently only possible under python3.10.
git clone https://github.com/GlacioHack/xdem.git
cd xdem
make install
After installing, you can check that everything is working by running the tests: pytest.
Dependencies#
xDEM’s required dependency is:
GeoUtils (version 0.2 and above),
with itself has required dependency on:
with second-order required dependencies being notably NumPy, pandas, pyproj and pyogrio.
Optional dependencies are:
Matplotlib for plotting,
LasPy for reading and writing LAS/LAZ/COPC point cloud files,
Numba as engine for certain numerical operations (terrain attributes),
Dask for out-of-memory operations (coming soon),
tqdm for displaying progress bars,
Cerberus, Pyyaml and Weasyprint for the command-line interface and workflows.