Commit 11a5065f authored by Eric Duminil's avatar Eric Duminil
Browse files

Updated MD

parent 7556847e
...@@ -49,6 +49,7 @@ src/simstadt/ ...@@ -49,6 +49,7 @@ src/simstadt/
runner.py # core workflow execution, SimStadt discovery runner.py # core workflow execution, SimStadt discovery
workflows.py # high-level helpers (heatdemand_simulation, etc.) workflows.py # high-level helpers (heatdemand_simulation, etc.)
utils.py # random_id, clean_old_workflows, etc. utils.py # random_id, clean_old_workflows, etc.
install.py # simstadt --install: download and extract SimStadt to ~/Desktop
templates/ # bundled workflow templates shipped with the package templates/ # bundled workflow templates shipped with the package
results/ results/
__init__.py # factory function, re-exports __init__.py # factory function, re-exports
......
...@@ -7,7 +7,8 @@ SimStadt is a city simulation tool for energy and urban analysis developed at HF ...@@ -7,7 +7,8 @@ SimStadt is a city simulation tool for energy and urban analysis developed at HF
## Requirements ## Requirements
- Python 3.10+ - Python 3.10+
- [SimStadt](https://simstadt.hft-stuttgart.de/download/InstallFiles/SimStadt2_latest.zip) installed separately - Java 17+
- [SimStadt](https://simstadt.hft-stuttgart.de/download/InstallFiles/SimStadt2_latest.zip) installed separately (or use `simstadt --install`)
## Installation ## Installation
...@@ -60,6 +61,9 @@ If no project path is specified, workflows are run in a temporary repository und ...@@ -60,6 +61,9 @@ If no project path is specified, workflows are run in a temporary repository und
# Print detected SimStadt installation path and version # Print detected SimStadt installation path and version
simstadt simstadt
# Download and install the latest SimStadt release to ~/Desktop
simstadt --install
# Launch the SimStadt GUI # Launch the SimStadt GUI
simstadt --gui simstadt --gui
......
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