From ba9087a25607b8a3acdcd34e44c5a0725de3caed Mon Sep 17 00:00:00 2001 From: Arsh Date: Fri, 28 Jun 2024 08:35:53 +0530 Subject: [PATCH] Updated Readme --- README.md | 32 +++++++++++++++++++------------- 1 file changed, 19 insertions(+), 13 deletions(-) diff --git a/README.md b/README.md index 3808c6c..daf8ae4 100644 --- a/README.md +++ b/README.md @@ -3,45 +3,52 @@ The Cities Indicator Framework (CIF) is a set of Python tools to make it easier to calculate zonal statistics for cities by providing a standardized set of data layers for inputs and a common framework for using those layers to calculate indicators. ## Quick start + * If all you want to do is use the CIF, the quickest way to get started is to use our [WRI Cities Indicator Framework Colab Notebook](https://colab.research.google.com/drive/1PV1H-godxJ6h42p74Ij9sdFh3T0RN-7j#scrollTo=eM14UgpmpZL-) ## Installation + * `pip install git+https://github.com/wri/cities-cif/releases/latest` gives you the latest stable release. * `pip install git+https://github.com/wri/cities-cif` gives you the main branch with is not stable. ## PR Review -0. Prerequisites - 1. Git - * On Windows I recommend WSL https://learn.microsoft.com/en-us/windows/wsl/tutorials/wsl-git - 3. https://cli.github.com/ - * On MacOS I recommend the Homebrew option - * If you don't have an ssh key, it will install one for you - 4. Conda (or Mamba) to install dependencies - * If you have Homebrew `brew install --cask miniconda` +0. Prerequisites +1. Git + * On Windows I recommend WSL +2. + * On MacOS I recommend the Homebrew option + * If you don't have an ssh key, it will install one for you +3. Conda (or Mamba) to install dependencies + * If you have Homebrew `brew install --cask miniconda` ## Dependencies + ### Conda + `conda env create -f environment.yml` ## Credentials + To run the module, you need access to Google Earth Engine. ### Interactive development + For most people working in a notebook or IDE the script should walk you thourgh an interactive authentication process. You will just need to be logged in to your Google account that has access to GEE in your browser. ### Programatic access + If you have issues with this or need to run the script as part of an automated workflow we have a GEE-enabled GCP service account that can be used. Get in touch with Saif or Chris to ask about getting the credetials. Set the following environment variables: -- GOOGLE_APPLICATION_CREDENTIALS: The path of GCP credentials JSON file containing your private key. -- GOOGLE_APPLICATION_USER: The email for your GCP user. -- GCS_BUCKET: The GCS bucket to read and write data from. + +* GOOGLE_APPLICATION_CREDENTIALS: The path of GCP credentials JSON file containing your private key. +* GOOGLE_APPLICATION_USER: The email for your GCP user. +* GCS_BUCKET: The GCS bucket to read and write data from. For example, you could set the following in your `~/.zshrc` file: ``` -export GCS_BUCKET=gee-exports export GOOGLE_APPLICATION_USER=developers@citiesindicators.iam.gserviceaccount.com export GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials/file ``` @@ -51,4 +58,3 @@ export GOOGLE_APPLICATION_CREDENTIALS=/path/to/credentials/file All are welcome to contribute by creating a [Pull Request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests). We try to follow the [Github Flow](https://docs.github.com/en/get-started/quickstart/github-flow) workflow. See the [developer docs](docs/developer.md) to learn more about how to add data layers and indicators. -