58 lines
1.2 KiB
Markdown
58 lines
1.2 KiB
Markdown
# Seed Data Plan
|
|
|
|
Seed data exists only to make the local developer experience and Codex implementation deterministic.
|
|
|
|
## Seed data rules
|
|
|
|
- Seed data must be clearly labeled as demo or fixture data.
|
|
- Seed data must never be presented as real GRB, OSM or official source data unless it actually comes from that source.
|
|
- Fixture geometries should be small and simple.
|
|
- Fixtures should support automated tests.
|
|
|
|
## Required seed entities
|
|
|
|
### Project
|
|
|
|
```json
|
|
{
|
|
"name": "Demo — Geel Building QA",
|
|
"description": "Fixture project for building detection and QA/QC workflow."
|
|
}
|
|
```
|
|
|
|
### Area
|
|
|
|
A small polygon near the Kempen demo viewport.
|
|
|
|
### Reference buildings
|
|
|
|
Use `fixtures/geojson/reference_buildings_fixture.geojson`.
|
|
|
|
### Predicted buildings
|
|
|
|
Use `fixtures/geojson/predicted_buildings_fixture.geojson`.
|
|
|
|
## Required seed command
|
|
|
|
Codex should add a command similar to:
|
|
|
|
```bash
|
|
python -m app.scripts.seed_demo
|
|
```
|
|
|
|
or a Make target:
|
|
|
|
```bash
|
|
make seed-demo
|
|
```
|
|
|
|
## Seed acceptance
|
|
|
|
After running seed:
|
|
|
|
- one project exists
|
|
- one area exists
|
|
- reference building dataset exists
|
|
- predicted building dataset or analysis output exists
|
|
- QA/QC can run against the two fixture layers
|