QUICKSTART

Important

Remember to check the installation prerequisites:

  • All OS: Miniconda or Anaconda

  • Windows: Microsoft Visual Build Tools C++ 14.0 or greater See instructions from the Installation section for more details.

Hint

For a successfull run see also Data requirements and instructions on how to fill the User configurations!

  1. Clone the repository from GitHub:

     git clone https://github.com/DigitalGeographyLab/green-paths-2

  2. Navigate to the Green Paths 2 root folder:

     cd green-paths-2

  3. Install Green Paths 2. Remember to run the CLI as administrator. Run the installation script from the root folder:

     Windows:
 install_green_paths_2.bat

 Mac / Linux:
 ./install_green_paths_2.sh

Note

NOTE: If the installation script has errors, please check the prerequisites from Installation!

Remember to deactivate the conda environment before installing and re-activate it after installation! and check the prerequisites for the installation from the installation section!

  1. Activate the conda environment:

     conda activate dgl_gp2

  2. Run the working example with:

     inv gp2 -a "-c green_paths_2/user/working_example_config.yaml all"

  3. See the results in the output folder.

     results_output

  4. After that you are ready to edit the user/config.yml and start running your own analysis e.g. Fill the user configurations in the user/config.yml file. See User Configurations. Validate the user configurations before running the pipeline.

     inv gp2 -a validate

and then run the whole pipeline:

    inv gp2 -a "all"

  1. Travel safe and healthy!