Skip to content

2. Spatial indicators and reporting software

Jump to bottom
Carl Higgs edited this page Oct 23, 2024 · 1 revision

How to set up and get started

Usage in brief

The Global Healthy and Sustainable Cities Indicators (GHSCI) tool can be run in a web browser or as Python code (e.g. in Jupyter Lab). Once the software environment has been retrieved and is running, analysis for a particular city proceeds in four steps:

  1. Install the Software
  2. Run the Example
  3. Configure study regions
  4. Perform region Analysis
  5. Generate resources
  6. Compare results (e.g. impact of hypothetical scenarios and sensitivity analysis, benchmarking between cities or regions of interest, monitoring change across time)

A fully configured example study region is provided along with data for users to familiarise themselves with the workflow and the possibilities of the generated resources. The instructions below will describe how to perform the analysis, and how to access, run and modify the provided example Jupyter notebook to perform analyses for your own study regions.

Software set up

  1. Download the GHSCI software

  2. Unzip the folder and save it to a desired project folder directory on your computer

  3. Install and run Docker Desktop according to the guidelines for your operating system of choice
    Make sure you have the latest version of Docker installed on your computer

  4. Run the GHSCI software by opening the project folder where you extracted the software using a command line interface (e.g. Terminal on Windows, Terminal on MacOS, or Bash on Linux):

  • on Windows open the folder in Terminal or cmd.exe and enter '.\global-indicators.bat'
  • on MacOS/Linux in bash, enter 'bash ./global-indicators.sh'
    • Linux users may need to prefix this with 'sudo' for elevated permissions when launching Docker containers (read more here)

This will retrieve the computational environment and launch the Global Healthy and Sustainable City Indicators (GHSCI) software, along with a PostGIS spatial database that is used for processing and data management. Once launched, instructions will be displayed (Figure 2).

image

Figure 2. With Docker Desktop installed and running, run the global-indicators command to initialise the software environment and view usage instructions

image

In the next step,

  • to launch the Web app, enter ghsci,
  • to launch Jupyter Lab in your browser, enter the lab,
  • for command line or Python directions, enter help.

For more details visit Running the Software

Clone this wiki locally