Skip to content

Commit 4deb812

Browse files
authored
Merge pull request #34 from ioalexei/readme_gvi_update
Update README.md
2 parents 51e2519 + fa85718 commit 4deb812

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

README.md

+21
Original file line numberDiff line numberDiff line change
@@ -84,6 +84,27 @@ For example, if you're continuing from the example in previous steps and already
8484
python -m src.download_images data/interim/Three_Rivers_Michigan_USA_points.gpkg data/raw/mapillary
8585
```
8686

87+
### 3. Assign a Green View score to each image/feature
88+
89+
Now that we have a point feature for each image, we want to calculate a Green View
90+
Index (GVI) score for each image and assign that score to the relevant point feature.
91+
We can use the [`assign_gvi_to_points.py`]('./src/assign_gvi_to_points.py') script
92+
for this.
93+
94+
For more information on how GVI is calculated, see Li et al. (2015),
95+
[_Who lives in greener neighborhoods?_](https://doi.org/10.1016/j.ufug.2015.07.006),
96+
Urban Forestry & Urban Greening 14, pp.751--759.
97+
98+
#### Example
99+
100+
This example follows from the files and directories created in previous steps and
101+
saves an output to a new file.
102+
103+
```bash
104+
python -m src.assign_gvi_to_points /data/raw/mapillary /data/interim/Three_Rivers_Michigan_USA_points.gpkg /data/processed/Three_Rivers_GVI.gpkg
105+
```
106+
107+
87108

88109
## Project Organization
89110

0 commit comments

Comments
 (0)