Skip to content

Commit

Permalink
README instructions on running yourself
Browse files Browse the repository at this point in the history
  • Loading branch information
bdon committed Jul 11, 2024
1 parent f35b8d2 commit ba25592
Showing 1 changed file with 22 additions and 6 deletions.
28 changes: 22 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,9 @@ To create a new tileset for only part of the world, use the `extract` command of

To get all `buildings` tiles around Ghent, Belgium:

`pmtiles extract https://.../buildings.pmtiles`
```
pmtiles extract https://.../buildings.pmtiles ghent.pmtiles --bbox=3.660507,51.004250,3.784790,51.065996
```

## Building Tilesets

Expand All @@ -39,16 +41,30 @@ Included is a [AWS CDK](https://docs.aws.amazon.com/cdk/v2/guide/getting_started

#### Requirements

* a [Java Runtime Environment](), version 22+, to build the `base`, `buildings` and `transportation` themes.
* a [Java Runtime Environment](), version 22+, to build the `base`, `buildings` and `transportation` themes, along with `planetiler.jar` from [onthegomap/planetiler Releases](https://github.com/onthegomap/planetiler/releases).
* the [felt/tippecanoe](https://github.com/felt/tippecanoe?tab=readme-ov-file#installation) tool and the [DuckDB CLI](https://duckdb.org/docs/installation/) for other themes.
* the [aws CLI](https://docs.aws.amazon.com/cli/latest/userguide/getting-started-install.html) for downloading Overture data.

#### Scripts

You can build the tilesets from raw data, modifying the `profiles/` and `scripts/`.

1. Copy the Overture Parquet dataset to your local machine to `overture` dir:
[Use these docs](https://github.com/OvertureMaps/data/blob/main/README.md#how-to-access-overture-maps-data). You don't need Microsoft Synapse or AWS Athena.
2. Install DuckDB and [felt/tippecanoe](https://github.com/felt/tippecanoe)
3. Run [places.sh places.pmtiles](scripts/2024-05-16-beta.0/places.sh) replacing `read_parquet(...)` with the path to your Overture copy. This streams GeoParquet into tippecanoe without any intermediate file.
* Copy the Overture Parquet dataset to your local machine
[using these docs](https://github.com/OvertureMaps/data/blob/main/README.md#how-to-access-overture-maps-data). If you want to only run on a small sample of data, you can use only the first `.parquet` file instead of all in the directory.

* for the `base`, `buildings` and `transportation` themes, generate the tileset with java:

```sh
# --data indicates where your Overture data is (overture/theme=base/...)
java -cp planetiler.jar profiles/Base.java --data=overture
```

The above command outputs `base.pmtiles` in the `data` dir.

* for other themes, run the theme script in `themes/`:

```sh
scripts/2024-06-13-beta/places.sh overture places.pmtiles
```

This reads from Overture data in `overture` and writes `places.pmtiles`.

0 comments on commit ba25592

Please sign in to comment.