Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[WIP]: Improve Documentation #1

Open
wants to merge 6 commits into
base: main
Choose a base branch
from
Open

[WIP]: Improve Documentation #1

Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
8633838
Use line breaks to make the docker run command readable.
rsarathy May 22, 2024
fb5ab4e
Genericize mapshaper sample command.
rsarathy May 22, 2024
c8d4e20
corresponding typo
rsarathy May 22, 2024
79bb696
Use line breaks to make the docker run command readable.
rsarathy May 22, 2024
6d0fc7a
Genericize mapshaper sample command.
rsarathy May 22, 2024
b98695e
Merge remote-tracking branch 'origin/rohit/improve-documentation' int…
rsarathy May 22, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 14 additions & 10 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,20 +7,18 @@ Makes OpenStreetMap cutouts from the larger USA data set.
* [docker](https://www.docker.com/)
* [node.js](https://nodejs.org/en)

## Usage

Add a geojson file that contains a Feature into the `./polygons` directory, add a corresponding entry in `./config.json`, then build and run the docker container.

Follow the steps below to use the tool to create your own cutouts. The San Francisco Bay Area consists of nine counties; they are used in the following example.

1. If you do not plan to run this locally, skip this step. Find and download the smallest `.osm.pbf` file that includes the entire area you want to extract from [Geofabrik's download page](https://download.geofabrik.de/north-america/us.html) (This example uses the Northern California file). This may take a while, so you can start this download, then move on to the next steps.
```
curl 'https://download.geofabrik.de/north-america/us/california/norcal-latest.osm.pbf' -o ./volumes/input/latest.osm.pbf
```
2. Decide what counties you want to include in your OSM cutout. Find each county in [counties-usa.geojson](counties-usa.geojson), confirm spelling, capitalization, etc...
3. Add all of the counties you want in your extract as a comma seperated list in the follow command, replacing `Alameda,Contra Costa,Marin,Napa,San Mateo,Santa Clara,Solano,Sonoma,San Francisco`. Set the name of the output file (replacing `bay-area-geometry.geojson` with something that makes sense). Then run it. This should create a geojson file in the `./polygons` directory.
2. Decide which counties you want to include in your OSM cutout. Find each county in [counties-usa.geojson](counties-usa.geojson), confirm spelling, capitalization, etc...
3. Add all the counties you want in your extract as a comma seperated list in the following command, e.g. `Alameda,Contra Costa,Marin,Napa,San Mateo,Santa Clara,Solano,Sonoma,San Francisco`. Set the name of the output file. Then run it. This should create a geojson file in the `./polygons` directory.
```
npx --yes mapshaper -i counties-usa.geojson -filter '"Alameda,Contra Costa,Marin,Napa,San Mateo,Santa Clara,Solano,Sonoma,San Francisco".indexOf(NAME) > -1' -dissolve2 -o ./polygons/san-francisco-bay-area.geojson geojson-type=Feature
npx --yes mapshaper \
-i counties-usa.geojson \
-filter '"{list-of-comma-separated-county-names}".indexOf(NAME) > -1' \
-dissolve2 \
-o ./polygons/{my-region-name}.geojson geojson-type=Feature
```
4. (optional) Create a convex hull of the counties. This is useful when the group of counties don't make a solid shape. Use the geojson file created in the previous step to make a new geojson file.
```
Expand All @@ -33,5 +31,11 @@ docker build . -t osm-extractor:testing-new-extract
```
7. (test) Generate the extract by running the docker container. This should create a new .pbf file in `./volumes/output`.
```
docker run -v ./volumes/output:/mnt/output -v ./volumes/input:/mnt/input osm-extractor:testing-new-extract osmium extract -d /mnt/output -c /app/config.json /mnt/input/latest.osm.pbf
docker run \
-v ./volumes/output:/mnt/output \
-v ./volumes/input:/mnt/input \
osm-extractor:testing-new-extract osmium extract \
-d /mnt/output \
-c /app/config.json \
/mnt/input/latest.osm.pbf
```