Commit 12884ebe authored by Eric Duminil's avatar Eric Duminil
Browse files

Updated README

parent 19d41ac7
......@@ -18,7 +18,7 @@ pip install simstadt
## Usage
```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")
print(results.dataframe)
......@@ -27,6 +27,9 @@ print(results.kpis)
pv = photovoltaic_simulation("path/to/city.gml", "Wuerzburg-hour.csv")
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
clean_old_workflows(Path("path/to/project.proj"))
```
......@@ -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/`.
## Health check
## CLI
```bash
# Print detected SimStadt installation path and version
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
......
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