Commit 43b3f24a authored by Eric Duminil's avatar Eric Duminil
Browse files

Updated documentation

parent 05596faf
...@@ -151,22 +151,24 @@ Output files: ...@@ -151,22 +151,24 @@ Output files:
/data/output.proj/20260921_0932_96on_HeatDemand.flow/05_MonthlyEnergyBalance.step/city_DIN18599_HEATING.log /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`: Bring your own templates by keeping them alongside your data and pointing `SIMSTADT_TEMPLATE_PATH` at them — a single mount, `compose.yaml`:
```yaml ```yaml
services: services:
simstadt: simstadt:
image: simstadt/simstadt:cli image: simstadt/simstadt:cli
volumes: volumes:
- ./data:/data - ./data:/data
environment: environment:
SIMSTADT_TEMPLATE_PATH: /data/templates SIMSTADT_TEMPLATE_PATH: /data/templates
LOCALE: en_GB # optional, will set decimal separator to "."
MAX_RAM: 2g # optional. Default is 4GB, increase if needed
``` ```
With `data/templates/MyTemplate.flow/` and `data/city.gml` on the host: With `data/templates/MyTemplate.flow/` and `data/city.gml` on the host:
```bash ```bash
docker compose run --rm simstadt simstadt MyTemplate /data/city.gml -p /data/output docker compose run --rm simstadt simstadt MyTemplate /data/city.gml --project-path /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