Skip to content

Commit

Permalink
Merge branch 'feature/open_buildings' of https://github.com/wri/citie…
Browse files Browse the repository at this point in the history
…s-cif into feature/smart_cities_lulc
  • Loading branch information
weiqi-tori committed May 28, 2024
2 parents ad4a882 + 9831b26 commit 158697d
Show file tree
Hide file tree
Showing 5 changed files with 349 additions and 85 deletions.
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,17 @@ The Cities Indicator Framework (CIF) is a set of Python tools to make it easier
## 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-)

## 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`


## Dependencies
### Conda
`conda env create -f environment.yml`
Expand Down
10 changes: 10 additions & 0 deletions docs/developer.md
Original file line number Diff line number Diff line change
Expand Up @@ -79,6 +79,16 @@ Hopefully we already have the layers you need in `city_metrix/layers/` and you c

4. Import the new layer class to [city_metrix/layers/\_\_init\_\_.py](../city_metrix/layers/__init__.py)

5. Add a test to [tests/layers.py](../tests/layers.py) to ensure the new layer is working as expected.

6. Add a section to the get layers.ipynb notebook to demonstrate how to use the new layer.

7. Create a PR to merge the new layer into the main branch with these in the PR description:
- Link to Jira ticket (if any)
- A brief description of the new layer
- A link to the Airtable record for the new layer
- Explain how to test the new layer


## Adding an Indicator
Once you have all the data layers you need as inputs, here is the process to create an indicator using them.
Expand Down
1 change: 1 addition & 0 deletions environment.yml
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,7 @@ dependencies:
- dask[complete]=2023.11.0
- matplotlib=3.8.2
- jupyterlab=4.0.10
- geemap=0.32.0
- pip=23.3.1
- pip:
- cartoframes==1.2.5
Loading

0 comments on commit 158697d

Please sign in to comment.