Skip to content

Commit

Permalink
Merge pull request #11 from OvertureMaps/rename-cdk
Browse files Browse the repository at this point in the history
Rename CDK from hello-cdk to overture-tiles-cdk
  • Loading branch information
bdon authored Jul 24, 2024
2 parents e808df1 + 8de5198 commit df45bc2
Show file tree
Hide file tree
Showing 10 changed files with 23 additions and 21 deletions.
25 changes: 13 additions & 12 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,22 +2,23 @@

Create tilesets from [Overture Maps](http://overturemaps.org) data.

These tilesets display an "X-ray" visualization of Overture data, for inspecting the breadth of Overture data and attributes. **They are not designed to be a production-ready cartographic basemap.**
These tilesets display an ["X-ray" visualization of Overture data](https://explore.overturemaps.org), for inspecting the breadth of Overture data and attributes. **They are not designed to be a production-ready cartographic basemap.**

Each Overture **theme** has an associated [PMTiles](https://github.com/protomaps/PMTiles) file.

View these tilesets in your browser:
* [base](https://pmtiles.io/?url=https%3A%2F%2Fhellocdkstack-overturetilesbucket6f38c611-6zusoghoh4au.s3.us-west-2.amazonaws.com%2F2024-06-13-beta%2Fbase.pmtiles)
* [buildings](https://pmtiles.io/?url=https%3A%2F%2Fhellocdkstack-overturetilesbucket6f38c611-6zusoghoh4au.s3.us-west-2.amazonaws.com%2F2024-06-13-beta%2Fbuildings.pmtiles)
* [divisions](https://pmtiles.io/?url=https%3A%2F%2Fhellocdkstack-overturetilesbucket6f38c611-6zusoghoh4au.s3.us-west-2.amazonaws.com%2F2024-06-13-beta%2Fdivisions.pmtiles)
* [places](https://pmtiles.io/?url=https%3A%2F%2Fhellocdkstack-overturetilesbucket6f38c611-6zusoghoh4au.s3.us-west-2.amazonaws.com%2F2024-06-13-beta%2Fplaces.pmtiles)
* [transportation](https://pmtiles.io/?url=https%3A%2F%2Fhellocdkstack-overturetilesbucket6f38c611-6zusoghoh4au.s3.us-west-2.amazonaws.com%2F2024-06-13-beta%2Ftransportation.pmtiles)
* [addresses](https://pmtiles.io/?url=https%3A%2F%2Foverturemaps-tiles-us-west-2-beta.s3.amazonaws.com%2F2024-07-22%2Faddresses.pmtiles)
* [base](https://pmtiles.io/?url=https%3A%2F%2Foverturemaps-tiles-us-west-2-beta.s3.amazonaws.com%2F2024-07-22%2Fbase.pmtiles)
* [buildings](https://pmtiles.io/?url=https%3A%2F%2Foverturemaps-tiles-us-west-2-beta.s3.amazonaws.com%2F2024-07-22%2Fbuildings.pmtiles)
* [divisions](https://pmtiles.io/?url=https%3A%2F%2Foverturemaps-tiles-us-west-2-beta.s3.amazonaws.com%2F2024-07-22%2Fdivisions.pmtiles)
* [places](https://pmtiles.io/?url=https%3A%2F%2Foverturemaps-tiles-us-west-2-beta.s3.amazonaws.com%2F2024-07-22%2Fplaces.pmtiles)
* [transportation](https://pmtiles.io/?url=https%3A%2F%2Foverturemaps-tiles-us-west-2-beta.s3.amazonaws.com%2F2024-07-22%2Ftransportation.pmtiles)

* S3: `s3://example-bucket/RELEASE/THEME.pmtiles`
* HTTP: `https://example-bucket.s3.amazonaws.com/RELEASE/THEME.pmtiles`
* S3: `s3://overturemaps-tiles-us-west-2-beta/RELEASE/THEME.pmtiles`
* HTTP: `https://overturemaps-tiles-us-west-2-beta.s3.amazonaws.com/RELEASE/THEME.pmtiles`

* `THEME`: one of `base`, `buildings`, `divisions`, `places`, `transportation`
* `RELEASE`: The Overture release name, not including minor version. For example, theme `buildings` in **data** release `2024-06-13-beta.0` will have tiles object name `2024-06-13-beta/buildings.pmtiles`.
* `THEME`: one of `addresses`, `base`, `buildings`, `divisions`, `places`, `transportation`
* `RELEASE`: The Overture release name, not including minor version. For example, theme `buildings` in **data** release `2024-07-22.0` will have tiles object name `2024-07-22/buildings.pmtiles`.

## How to Use

Expand All @@ -28,7 +29,7 @@ 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 ghent.pmtiles --bbox=3.660507,51.004250,3.784790,51.065996
pmtiles extract https://overturemaps-tiles-us-west-2-beta.s3.amazonaws.com/2024-07-22/buildings.pmtiles ghent.pmtiles --bbox=3.660507,51.004250,3.784790,51.065996
```

## Building Tilesets
Expand Down Expand Up @@ -64,7 +65,7 @@ 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
scripts/2024-07-22/places.sh overture places.pmtiles
```

This reads from Overture data in `overture` and writes `places.pmtiles`.
File renamed without changes.
File renamed without changes.
File renamed without changes.
Original file line number Diff line number Diff line change
@@ -1,10 +1,10 @@
#!/usr/bin/env node
import 'source-map-support/register';
import * as cdk from 'aws-cdk-lib';
import { HelloCdkStack } from '../lib/hello-cdk-stack';
import { OvertureTilesCdkStack } from '../lib/overture-tiles-cdk-stack';

const app = new cdk.App();
new HelloCdkStack(app, 'HelloCdkStack', {
new OvertureTilesCdkStack(app, 'OvertureTilesCdkStack', {
/* If you don't specify 'env', this stack will be environment-agnostic.
* Account/Region-dependent features and context lookups will not work,
* but a single synthesized template can be deployed anywhere. */
Expand Down
2 changes: 1 addition & 1 deletion hello-cdk/cdk.json → overture-tiles-cdk/cdk.json
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{
"app": "npx ts-node --prefer-ts-exts bin/hello-cdk.ts",
"app": "npx ts-node --prefer-ts-exts bin/overture-tiles-cdk.ts",
"watch": {
"include": [
"**"
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ import { aws_iam as iam } from "aws-cdk-lib";

const ID = "OvertureTiles";

export class HelloCdkStack extends cdk.Stack {
export class OvertureTilesCdkStack extends cdk.Stack {
constructor(scope: Construct, id: string, props?: cdk.StackProps) {
super(scope, id, props);

Expand All @@ -36,6 +36,7 @@ export class HelloCdkStack extends cdk.Stack {
});

const bucket = new s3.Bucket(this, `${ID}Bucket`, {
bucketName: 'overturemaps-tiles-us-west-2-beta',
blockPublicAccess: new s3.BlockPublicAccess({
blockPublicAcls: false,
blockPublicPolicy: false,
Expand Down

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

4 changes: 2 additions & 2 deletions hello-cdk/package.json → overture-tiles-cdk/package.json
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
{
"name": "hello-cdk",
"name": "overture-tiles-cdk",
"version": "0.1.0",
"bin": {
"hello-cdk": "bin/hello-cdk.js"
"overture-tiles-cdk": "bin/overture-tiles-cdk.js"
},
"scripts": {
"build": "tsc",
Expand Down
File renamed without changes.

0 comments on commit df45bc2

Please sign in to comment.