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
12884ebe
Commit
12884ebe
authored
Apr 01, 2026
by
Eric Duminil
Browse files
Updated README
parent
19d41ac7
Changes
1
Hide whitespace changes
Inline
Side-by-side
README.md
View file @
12884ebe
...
@@ -18,7 +18,7 @@ pip install simstadt
...
@@ -18,7 +18,7 @@ pip install simstadt
## Usage
## Usage
```
python
```
python
from
simstadt
import
heatdemand_simulation
,
photovoltaic_simulation
,
clean_old_workflows
from
simstadt
import
heatdemand_simulation
,
photovoltaic_simulation
,
greenwater_simulation
,
clean_old_workflows
results
=
heatdemand_simulation
(
"path/to/city.gml"
,
"Wuerzburg-hour.csv"
)
results
=
heatdemand_simulation
(
"path/to/city.gml"
,
"Wuerzburg-hour.csv"
)
print
(
results
.
dataframe
)
print
(
results
.
dataframe
)
...
@@ -27,6 +27,9 @@ print(results.kpis)
...
@@ -27,6 +27,9 @@ print(results.kpis)
pv
=
photovoltaic_simulation
(
"path/to/city.gml"
,
"Wuerzburg-hour.csv"
)
pv
=
photovoltaic_simulation
(
"path/to/city.gml"
,
"Wuerzburg-hour.csv"
)
print
(
pv
.
dataframe
)
print
(
pv
.
dataframe
)
gw
=
greenwater_simulation
(
"path/to/city.gml"
,
"Wuerzburg-hour.csv"
,
irrigation_ratio
=
0.5
)
print
(
gw
.
dataframe
)
# Remove workflow folders older than 1 hour from a project directory
# Remove workflow folders older than 1 hour from a project directory
clean_old_workflows
(
Path
(
"path/to/project.proj"
))
clean_old_workflows
(
Path
(
"path/to/project.proj"
))
```
```
...
@@ -51,13 +54,24 @@ Bundled workflow templates are used by default. Custom templates are resolved vi
...
@@ -51,13 +54,24 @@ Bundled workflow templates are used by default. Custom templates are resolved vi
If no project path is specified, workflows are run in a temporary repository under
`/tmp/simstadt_repo/`
.
If no project path is specified, workflows are run in a temporary repository under
`/tmp/simstadt_repo/`
.
##
Health check
##
CLI
```
bash
```
bash
# Print detected SimStadt installation path and version
simstadt
simstadt
```
Prints the detected SimStadt installation path and version.
# Launch the SimStadt GUI
simstadt
--gui
# Run a workflow from the command line
simstadt 104_HeatDemandWithShadow path/to/city.gml
-v
# Save results to CSV or JSON
simstadt 104_HeatDemandWithShadow path/to/city.gml
--save
results.csv
# Run RegionChooser (separate entry point)
regionchooser
```
## 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