Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
SimStadt
simstadtpy
Commits
43b3f24a
Commit
43b3f24a
authored
Sep 21, 2026
by
Eric Duminil
Browse files
Updated documentation
parent
05596faf
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
43b3f24a
...
@@ -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.y
a
ml`
:
```
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
...
...
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment