mgrs-pmtiles / README.md
hfujimura's picture
Update README.md
717a9dc verified
---
license: cc0-1.0
pretty_name: MGRS PMTiles
language:
- en
tags:
- geospatial
- maps
- pmtiles
- vector-tiles
- mgrs
- hokkaido
task_categories:
- other
viewer: false
size_categories:
- 1M<n<10M
configs:
- config_name: default
data_files:
- split: train
path: mgrs-hokkaido.pmtiles
dataset_info:
features: []
splits:
- name: train
num_bytes: 5710000000
num_examples: 1
---
# MGRS PMTiles
PMTiles distribution of an MGRS-based tasking grid.
This dataset repository currently publishes the following artifact:
- `mgrs-hokkaido.pmtiles`
## Summary
This Hugging Face dataset repository is used as a **distribution endpoint** for PMTiles artifacts.
The source code, generation workflow, implementation details, and technical background are maintained in the upstream GitHub repository:
- **Source repository:** https://github.com/hfu/mgrs-pmtiles
If you want to understand how this PMTiles file was generated, please refer to the GitHub repository.
## Data included
### Files
- `mgrs-hokkaido.pmtiles`
### Coverage
Current published coverage:
- **Hokkaido, Japan**
## Description
This artifact contains an **MGRS-based tasking grid** packaged as a PMTiles archive for distribution and downstream geospatial use.
The upstream project defines multiple grid resolutions with zoom-dependent layer allocation.
### Zoom levels
- `mgrs_100km`: minzoom 3 / maxzoom 7
- `mgrs_10km`: minzoom 8 / maxzoom 10
- `mgrs_1km`: minzoom 11 / maxzoom 12
- `mgrs_100m`: minzoom 13 / maxzoom 16
## Source and generation
Source code and generation pipeline:
- https://github.com/hfu/mgrs-pmtiles
According to the upstream repository, the PMTiles artifact is generated through a pipe-based workflow:
- `src/generate-grids.js` emits GeoJSON Text Sequence to stdout
- `tippecanoe` consumes the stream directly
- temporary GeoJSON Text Sequence files are not used
- stdout blocking is enabled to reduce the risk of stream loss during large output generation
For implementation details, development notes, and updates, please refer to the GitHub repository.
## Intended use
This dataset may be useful for:
- PMTiles-based map distribution
- experimentation with MGRS-based tasking grids
- downstream geospatial visualization
- analysis workflows involving tiled grid datasets
## Limitations
- This repository is primarily for **artifact distribution**
- Build and generation details are maintained in the upstream GitHub repository
- The currently published artifact covers **Hokkaido, Japan**
- Users should independently validate fitness for operational or production use
## Important note
The upstream repository includes an important caution that the implementation was developed as a prototype with significant assistance from generative AI and may not have undergone full human review.
Please review the source repository and perform appropriate technical, quality, and legal review before production use.
## Licensing
This dataset is released under:
- **CC0 1.0** (`cc0-1.0`)
## Repository links
- **Hugging Face dataset:** https://huggingface.co/datasets/smartmaps/mgrs-pmtiles
- **GitHub source repository:** https://github.com/hfu/mgrs-pmtiles