README.md

tzf's preprocessed timezone data

Update Data Steps

CI

Data build in GitHub Actions.

Local build

1. Install CLI tool

# install tools
go install github.com/ringsaturn/tzf/cmd/geojson2tzpb@latest
go install github.com/ringsaturn/tzf/cmd/reducetzpb@latest
go install github.com/ringsaturn/tzf/cmd/compresstzpb@latest
go install github.com/ringsaturn/tzf/cmd/preindextzpb@latest

2. Set data version to build(Below steps need this environment var)

export TIMEZONE_BOUNDARY_VERSION=2023b

3. Download data

# download data
wget https://github.com/evansiroky/timezone-boundary-builder/releases/download/${TIMEZONE_BOUNDARY_VERSION}/timezones-with-oceans.geojson.zip
unzip timezones-with-oceans.geojson.zip

4. Make data

geojson2tzpb combined-with-oceans.json | xargs reducetzpb | xargs compresstzpb
preindextzpb combined-with-oceans.reduce.pb

References

• Protocol Buffers define: https://github.com/ringsaturn/tzf/blob/main/pb/tzinfo.proto

• Maintain tools

  • checkboundaryrelease
  • geojson2tzpb
  • reducetzpb
  • compresstzpb
  • preindextzpb

• To view data in GeoJSON format(which is more convenient to show on map), see https://github.com/ringsaturn/tzf-server

• Data Usage examples

  • Go: https://github.com/ringsaturn/tzf
  • Rust: https://github.com/ringsaturn/tzf-rs