Taking part to a GlacioHack

This wiki page summarizes tips on how to contribute to the GlacioHack packages during a hack event.

Install a local copy of a GlacioHack repository

1. Create a fork of the repositories you plan to work on.

2. Clone the repositories on your computer, e.g.:

cd path/where/to/install
git clone https://github.com/GlacioHack/GeoUtils.git
git clone https://github.com/GlacioHack/xdem.git

3. Install the repository: this should be explained at each repository's level (here for GeoUtils and xdem) I recommend installing the dependencies for xdem, which include all the dependencies for GeoUtils and more. This requires installing conda if not already done.

# Install xdem dependencies
conda env create -f ./xdem/environment.yml
conda activate xdem
# Install the dev dependencies, needed for testing etc
pip install -r xdem/dev-requirements.txt
# Install xdem
cd xdem
pip install -e .
# Install geoutils and force use the cloned version instead of pip's
pip uninstall geoutils
cd ../GeoUtils
pip install -e .

N.B.: Installing the whole environment will take several minutes, be patient... or read the N.B below... and yet be patient as it may still take several minutes.

N.B.2: To speed up the process, you may want to use mamba instead of conda:

conda install -c conda-forge mamba
mamba env create -f environment.yml

and replace all other conda commands with mamba.

4. Test that the install worked. The following command should return no error:

python -c "import geoutils; import xdem"