Commit 05596faf authored by Eric Duminil's avatar Eric Duminil
Browse files

More documentation about docker

parent 6bf4d76f
...@@ -125,18 +125,48 @@ docker run --rm simstadt/simstadt:cli ...@@ -125,18 +125,48 @@ docker run --rm simstadt/simstadt:cli
# Run a workflow against a mounted CityGML file # Run a workflow against a mounted CityGML file
mkdir -p data mkdir -p data
cp path/to/city.gml data/building.gml cp path/to/city.gml data/city.gml
docker run --rm -v "$(pwd)/data:/data" simstadt/simstadt:cli \ docker run --rm -v "$(pwd)/data:/data" simstadt/simstadt:cli simstadt HeatDemand /data/city.gml -p /data/output --files
simstadt HeatDemand /data/building.gml -p /data/output -f
``` ```
Results are written to `data/output.proj/` on the host. Results are written to `data/output.proj/` on the host:
Bring your own templates by mounting them and overriding `SIMSTADT_TEMPLATE_PATH`: ```
HeatDemand for city.gml
Number of buildings : 137
Number of heated buildings : 91
Specific Heating demand : 95 kWh / (m² · a)
Heated area : 83034 m²
Footprint area : 19767 m²
Yearly Heating demand : 6598939 kWh / a
Total Yearly Heating + DHW demand : 7916193 kWh / a
Mean Uvalue : 1.3 W / (m² · K)
Year of construction : 1946
Storey number : 5
Output files:
/data/output.proj/20260921_0932_96on_HeatDemand.flow/02_WeatherProcessor.step/hourly_GHI_DHI_Ta_pvgis_SARAH3_2005_2023_N49_8__E9_9.prn
/data/output.proj/20260921_0932_96on_HeatDemand.flow/05_MonthlyEnergyBalance.step/city_DIN18599_HEATING.csv
/data/output.proj/20260921_0932_96on_HeatDemand.flow/05_MonthlyEnergyBalance.step/city_DIN18599_HEATING.log
```
Bring your own templates by keeping them alongside your data and pointing `SIMSTADT_TEMPLATE_PATH` at them — a single mount, `docker-compose.yml`:
```yaml
services:
simstadt:
image: simstadt/simstadt:cli
volumes:
- ./data:/data
environment:
SIMSTADT_TEMPLATE_PATH: /data/templates
```
With `data/templates/MyTemplate.flow/` and `data/city.gml` on the host:
```bash ```bash
docker run --rm -v "$(pwd)/data:/data" -e SIMSTADT_TEMPLATE_PATH=/data/templates \ docker compose run --rm simstadt simstadt MyTemplate /data/city.gml -p /data/output
simstadt/simstadt:cli simstadt MyTemplate /data/building.gml -p /data/output
``` ```
## Development ## Development
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment