Skip to content

Commit af2bddf

Browse files
committed
docs: enhance setup documentation; clarify data organization, update warnings, and improve notes on local development setup
1 parent 0ba827f commit af2bddf

3 files changed

Lines changed: 150 additions & 55 deletions

File tree

README.md

Lines changed: 42 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,34 +16,62 @@ City2TABULA focuses on scalable, database-centric processing of large national-
1616

1717
---
1818

19-
## Getting started
19+
## Quick Start
2020

21-
For setup and installation guide, please refer to [docs/getting-started/setup.md](https://thd-spatial-ai.github.io/city2tabula/installation/setup/)
21+
**Prerequisite:** [Docker](https://docs.docker.com/get-docker/)
2222

23-
Local docs preview (MkDocs):
23+
```bash
24+
make setup # Build image, start containers (PostGIS + CityDB CLI included)
25+
make create-db # Create database and import data
26+
make extract-features
27+
```
28+
29+
Full setup instructions for all platforms (Linux, macOS, Windows) are in the [installation guide](https://thd-spatial-ai.github.io/city2tabula/installation/setup/).
30+
31+
---
32+
33+
## Local Documentation (MkDocs)
2434

2535
```bash
2636
python -m pip install -r docs/requirements.txt
2737
python -m mkdocs serve
2838
```
2939

40+
---
41+
3042
## CLI
3143

32-
Build locally:
44+
### Flags
45+
46+
| Flag | Description |
47+
|------|-------------|
48+
| `-create-db` | Create the complete City2TABULA database (CityDB infrastructure + schemas + data import) |
49+
| `-reset-db` | Reset everything: drop all schemas and recreate the complete database |
50+
| `-reset-citydb` | Reset only CityDB infrastructure (drop CityDB schemas, recreate, and re-import data) |
51+
| `-reset-city2tabula` | Reset only City2TABULA schemas (preserves CityDB) |
52+
| `-extract-features` | Run the feature extraction pipeline |
53+
| `-version` / `-v` | Print version and exit |
54+
55+
---
56+
57+
## Testing
3358

3459
```bash
35-
go build -o city2tabula ./cmd
36-
./city2tabula --help
37-
```
60+
# Unit tests
61+
go test ./...
3862

39-
Common flags:
63+
# Unit tests with coverage
64+
go test -coverprofile=coverage.out -covermode=atomic ./...
65+
go tool cover -html=coverage.out
4066

41-
- `-create-db`
42-
- `-reset-db`
43-
- `-reset-citydb`
44-
- `-reset-city2tabula`
45-
- `-extract-features`
46-
- `-version` / `-v`
67+
# Integration tests (requires Docker)
68+
go test -tags integration -v -timeout 10m ./internal/process/
69+
70+
# SQL benchmarks (requires Docker)
71+
go test -tags integration -bench=. -benchmem -run=^$ ./internal/process/
72+
```
73+
74+
---
4775

4876
## License
4977

0 commit comments

Comments
 (0)