Commit 5fb2e479 authored by Eric Duminil's avatar Eric Duminil
Browse files

Updated doc

parent c1449e9f
......@@ -163,6 +163,28 @@ cd examples
docker compose run --rm simstadt simstadt MyTemplate /data/city.gml --project-path /data/output --save /data/my_simulation.csv --verbose
```
Available tags are:
* `base`: with Java + INSEL + SimStadt
* `cli`: with Java + INSEL + SimStadt + simstadtpy
As the name implies, `base` can be used by other projects as a base image, adding their own libraries on top. `base` can run SimStadt workflows with the simple SimStadt.sh syntax, pointing to a repository, project or workflow:
```
docker run --rm -v "$(pwd)/data:/data" simstadt/simstadt:base \
/opt/SimStadt2/SimStadt.sh /data/output.proj/MyWorkflow.flow
# Launching: java -classpath lib/*:workflows/* -Xms512m -Xmx4g -Dlogback.configurationFile=./logging_configuration.xml -Dcolor eu.simstadt.desktop.SimStadtCommandLineInterface /data/output.proj/20260921_2007_zeo9_HeatDemand.flow
# 06:33:53 |INFO | e.s.d.SimStadtCommandLineInterface - Launching SimStadt 0.14.0-SNAPSHOT (master, rev. fe4fa3c, 20260914) [main]
# 06:33:53 |INFO | e.s.d.SimStadtCommandLineInterface - Input looks like a Workflow. [main]
# 06:33:54 |INFO | e.s.d.SimStadtCommandLineInterface - Found repository: /data [main]
# 06:33:54 |INFO | e.s.d.SimStadtCommandLineInterface - Found project: output [main]
# 06:33:54 |INFO | e.s.d.SimStadtCommandLineInterface - Found workflow: CityGmlWorkflow [name=CGSC_HeatDe
# ...
```
`gui` will be added too, allowing to run the SimStadt GUI in the browser, similarly to [`web-insel`](hub.docker.com/r/inseleu/web-insel).
## Development
```bash
......
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