Skip to main content

Python library for using and testing SimStadt workflows.

Project description

simstadt

A Python library for running and testing SimStadt workflows programmatically.

SimStadt is a city simulation tool for energy and urban analysis developed at HFT Stuttgart. This library wraps its CLI to execute workflows against CityGML files and parse the results into pandas DataFrames.

Requirements

  • Python 3.10+
  • SimStadt installed separately

Installation

pip install simstadt

Usage

from simstadt import heatdemand_simulation, photovoltaic_simulation

results = heatdemand_simulation("path/to/city.gml", "Wuerzburg-hour.csv")
print(results.dataframe)
print(results.kpis)

pv = photovoltaic_simulation("path/to/city.gml", "Wuerzburg-hour.csv")
print(pv.dataframe)

SimStadt is located automatically via the SIMSTADT_FOLDER environment variable, or by searching ~/Desktop for a SimStadt2_0.*/ directory.

Workflow templates are resolved via SIMSTADT_TEMPLATE_PATH, or a Template/ directory in the current working directory.

Development

uv sync
uv run pytest

AI agent

SimStadtResults and tests have been written manually during research projects.

Claude Code has been used to refactor and package the scripts into this library.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

simstadt-0.1.1.tar.gz (13.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simstadt-0.1.1-py3-none-any.whl (19.5 kB view details)

Uploaded Python 3

File details

Details for the file simstadt-0.1.1.tar.gz.

File metadata

  • Download URL: simstadt-0.1.1.tar.gz
  • Upload date:
  • Size: 13.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Linux Mint","version":"22.2","id":"zara","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for simstadt-0.1.1.tar.gz
Algorithm Hash digest
SHA256 8b16cea97d28a92d0cb1da8eeac021e67c3becff470f0307d4294fe8139af907
MD5 e5a51d8a15568d86e40139f550ee43f4
BLAKE2b-256 15818bf5e83b6b594f5966dbeb3b6c68cd2e57a2a10719054ac5bede25333519

See more details on using hashes here.

File details

Details for the file simstadt-0.1.1-py3-none-any.whl.

File metadata

  • Download URL: simstadt-0.1.1-py3-none-any.whl
  • Upload date:
  • Size: 19.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.9.21 {"installer":{"name":"uv","version":"0.9.21","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Linux Mint","version":"22.2","id":"zara","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":null}

File hashes

Hashes for simstadt-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0c6f3f012c17b5e95bc0ab79c40c829d817949d122a2bb1e2806dc4344f8ed48
MD5 9574d32ddb8e5d2c258c7815aed2913d
BLAKE2b-256 c1d60323517a9822be8f74f096078d1b199c144f1c7225ed6f5fc0dd374a1438

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page