search

AmericanRedCross / street-view-green-view

BSD 3-Clause "New" or "Revised" License
8 stars 9 forks source link

`create_points.py` documentation and improve demo notebook #3

Closed jayqi closed 5 months ago

jayqi commented 5 months ago

Adds instructions to README for project setup and for running create_points.py to sample points given road data.

Also added a CONTRIBUTING.md with instructions for how to check out a branch from a fork. @ayoakin see this so you don't have to merge this PR in order to check out the branch.

Note that I added a new file to the Google Drive to facilitate this workflow. The original shapefile ZIP archive we had Three_Rivers_Michigan_USA_shp_uid_ae45a8ad-f097-4fd3-bec9-31a366f92657 2.zip is not a valid zipped shapefile (meaning programs don't know how to directly load it) because the contents are nested in a subdirectory, e.g., Three_Rivers_Michigan_USA_shp_uid_ae45a8ad-f097-4fd3-bec9-31a366f92657 2/Three_Rivers_Michigan_USA_line.shp vs. justThree_Rivers_Michigan_USA_line.shp. I've added a version [Three_Rivers_Michigan_USA_line.zip`](https://drive.google.com/file/d/1fpI4I5KP2WyVD5PeytW_hoXZswOt0dwA/view?usp=drive_link) with that subdirectory removed.

I've also updated the Juptyer notebook to be more clear: view with nbviewer here.

@danbjoseph I think this should address the questions that you had. Let me know if there's anything else you find confusing.

danbjoseph commented 5 months ago

thank you @jayqi for completing this, and thank you @ayoakin for reviewing and merging!