Skip to content

docs: add local (non-Docker) setup steps for Linux/macOS #74

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
jravani wants to merge 1 commit into from
Closed

docs: add local (non-Docker) setup steps for Linux/macOS #74

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
52 changes: 50 additions & 2 deletions docs/installation/setup.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,5 +140,53 @@ setup.bat extract-features
| Git | 2.25+ | required for City2TABULA | [git-scm.com](https://git-scm.com/downloads) |
| CityDB Importer/Exporter | v1.1.0 | Unzip and place the `citydb-tool` directory at your preferred location. | [github.com](https://github.com/3dcitydb/citydb-tool/releases/tag/v1.1.0) |

!!! info "Coming soon..."
Steps for local development setup will be added in future updates. For now, refer to the Docker setup instructions for a streamlined installation process.
### Step 1. Clone the repository

```bash
git clone https://github.com/thd-spatial-ai/city2tabula.git
cd city2tabula
```

### Step 2. Install PostgreSQL, PostGIS and the CityDB tool

Install the versions listed in the prerequisites table above. Unzip the CityDB Importer/Exporter release and note the path to the extracted `citydb-tool-<version>` directory — you'll need it in Step 4.

### Step 3. Build the binary

```bash
go build -o city2tabula ./cmd
```

### Step 4. Configure environment variables

```bash
cp .env.example .env
```

Edit `.env` and set at minimum:

```bash
COUNTRY # e.g. germany — must match one of the supported TABULA/EPISCOPE countries
DB_HOST / DB_PORT / DB_USER / DB_PASSWORD / DB_NAME # your local PostgreSQL instance
CITYDB_SRID / CITYDB_SRS_NAME # matching your COUNTRY, see the reference list in .env.example
CITYDB_TOOL_PATH # path to the citydb-tool directory from Step 2
```

### Step 5. Add your data

Place your 3D city data file(s) under `data/`, following the same layout as the Docker setup:

```bash
data/
├── lod2/<country>/*(.gml | .json)
└── lod3/<country>/*(.gml | .json)
```

### Step 6. Create the database and run the pipeline

```bash
./city2tabula -create-db # creates CityDB + City2TABULA schemas and imports your data
./city2tabula -extract-features # runs the feature extraction pipeline
```

Use `./city2tabula -help` to see all available flags (e.g. `-reset-db`, `-link-pylovo`).
Loading