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

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.0.tar.gz (12.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.0-py3-none-any.whl (14.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: simstadt-0.1.0.tar.gz
  • Upload date:
  • Size: 12.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.0.tar.gz
Algorithm Hash digest
SHA256 fb174a3322e18783f2adf99f824eafbaa752e9d4f326f786bf82660586e57e8c
MD5 6a0f6c01c542a69c640a4a43714034b3
BLAKE2b-256 58754cdea06d6d36128662fa325143521243916703a284be022a5ec16dc4ab2c

See more details on using hashes here.

File details

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

File metadata

  • Download URL: simstadt-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 14.9 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.0-py3-none-any.whl
Algorithm Hash digest
SHA256 f7c59b1cb55655f39a118d4d35b05727212291bf5574dc35c2d7148551e0fd59
MD5 db4d06af4b62402b052a909c2c7ab98c
BLAKE2b-256 894f7f9234e400ddba945ca44d77dd99f1d2f093e1ea16f12185c3ad90a92b68

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