You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
feat: delegate generate to sl-5-8 via INPUT_DIR, add prereqs + docs
- Simplify root generate target to delegate to sl-5-8-asset-tools via
INPUT_DIR/OUTPUT_DIR variables (removes duplicated pipeline invocation).
- Add Prerequisites section with install instructions for Windows
(PowerShell, Git Bash), macOS, and Linux.
- Add direct Python invocation examples for Make-free usage (PowerShell).
- Add debug logging section with Bash and PowerShell syntax.
- Add Podman/Docker Desktop troubleshooting table.
- Update Option B (manual pipeline) to show paths work from any CWD.
- Add custom INPUT_DIR usage to make help output.
- Note make clean all as fix for stale QC checker packages.
Signed-off-by: jdsika <carlo.van-driesten@bmw.de>
**Git Bash / MSYS2** — Make is included if you selected the MSYS2 option during Git install, or install it with:
23
+
24
+
```bash
25
+
# Using Scoop (recommended)
26
+
scoop install make
27
+
28
+
# Using Chocolatey
29
+
choco install make
30
+
```
31
+
32
+
**PowerShell** — The same `scoop` or `choco` commands work. After installing, `make` uses Git's bundled `sh.exe` for recipe execution, so it works from PowerShell, Git Bash, and CMD alike.
33
+
34
+
**Without Make** — You can run the pipeline directly with Python (see [Option B](#option-b--run-the-pipeline-directly) below).
35
+
36
+
</details>
37
+
38
+
<details>
39
+
<summary><strong>macOS / Linux</strong></summary>
40
+
41
+
Make and Git are typically pre-installed. Install Python 3.12+ via your package manager:
42
+
43
+
```bash
44
+
# macOS
45
+
brew install python@3.12
46
+
47
+
# Ubuntu/Debian
48
+
sudo apt install python3.12 python3.12-venv
49
+
```
50
+
51
+
</details>
52
+
53
+
> **Podman** is only needed for `make wizard` (the SD Creation Wizard web UI). The pipeline itself does not require it. Podman is auto-installed by `make setup wizard` if missing.
54
+
11
55
## Quick Start
12
56
13
57
```bash
@@ -160,11 +204,12 @@ To create a new HD-Map asset from **your own** `.xodr` file, you have two option
160
204
161
205
The pipeline will run all steps and produce a fresh asset in `generated/output/`.
162
206
163
-
### Option B — Run the pipeline manually
207
+
### Option B — Run the pipeline directly
164
208
165
-
Create a working directory with all your input files**and**an `uploadedFiles.json` manifest:
209
+
You can invoke the pipeline from any directory without `make`. This works in**any shell**— Bash, PowerShell, CMD:
166
210
167
211
```bash
212
+
# Create a working directory with your input files
@@ -308,11 +352,27 @@ You need to use the following ontology from [Ontology Management Base Repository
308
352
309
353
### What does the pipeline need to run?
310
354
311
-
-**Python 3.12+**and `make`
312
-
- The `sl-5-8-asset-tools` submodule (initialized via `git submodule update --init --recursive`)
355
+
-**Python 3.12+**, **Git**, and **GNU Make** (see [Prerequisites](#prerequisites))
356
+
- The `sl-5-8-asset-tools` submodule (initialized via `git submodule update --init --recursive` or `make setup`)
313
357
-**Internet connection** — required only for reverse geocoding (Nominatim API); ontology schemas and SHACL shapes are provided locally by the `ontology-management-base` submodule
314
358
- For quality checking (optional): run `make setup qc` to install the ASAM and OpenMSL checker tools from GitHub
Shows full subprocess command lines, stdout/stderr, and tracebacks.
375
+
316
376
### What is the `uploadedFiles.json`?
317
377
318
378
It's a simple JSON array that tells the pipeline which files to process and how to categorize them. Each entry has:
@@ -326,5 +386,15 @@ When using `make generate`, this file is created automatically.
326
386
### Known Limitations
327
387
328
388
-**Geocoding timeouts** — The `meta_data_extractor` uses the Nominatim API for reverse geocoding. If the API is slow or rate-limited, the pipeline may fail. Simply retry.
329
-
-**Quality checkers require extra install** — The `[qc]` optional dependencies install from Git branches and may take a while. Without them, quality checking is skipped (no validation reports generated).
389
+
-**Quality checkers require extra install** — The `[qc]` optional dependencies install from Git branches and may take a while. Without them, quality checking is skipped (no validation reports generated). If you see stale checker errors after switching branches, run `make clean all && make setup` to get a fresh environment.
330
390
-**Ontology versions** — The pipeline generates metadata using the **latest** ontology versions. Both current and older versions are valid but produce different JSON-LD structures.
391
+
392
+
### Podman / Wizard Troubleshooting
393
+
394
+
The SD Creation Wizard (`make wizard`) uses Podman containers. Common issues on Windows:
395
+
396
+
| Error | Cause | Fix |
397
+
|-------|-------|-----|
398
+
|`CreateFile \\.\pipe\docker_engine: All pipe instances are busy`| Docker Desktop is running and holds the Docker API pipe | Quit Docker Desktop before starting Podman, or run `podman machine stop && podman machine start`|
399
+
|`machine not in running state`| Podman machine failed to start | Run `podman machine rm` then `podman machine init && podman machine start`|
400
+
| Port 4200 or 8080 already in use | Another process holds the port |`make wizard stop` first, or stop the other process |
0 commit comments