URBANopt District Energy Systems (DES)

Overview

The URBANopt District Energy Systems (DES) Package is an extension of the URBANopt SDK designed to analyze the results of URBANopt simulated district energy systems. This package combines results from OpenStudio/EnergyPlus with results from Modelica/Buildings Library to provide detailed thermal and energy performance analysis at a district scale.

This project pulls in the GeoJSON to Modelica Translator (and required dependencies).

Installation

pip install urbanopt-des

Developer installation

  • Clone the repository: git clone https://github.com/urbanopt/urbanopt-des.git
  • Change directories into the repository: cd urbanopt-des
  • We recommend using virtual environments on principle to avoid dependencies colliding between your Python projects. venv is the Python native solution that will work everywhere, though other options may be more user-friendly.

Once you have set up your environment:

  1. pip install -U pip setuptools poetry
    • This will update pip & setuptools, and install Poetry to manage the project
  2. poetry install
    • This installs the project and all dependencies
  3. Activate pre-commit (only once, after making a new venv): poetry run pre-commit install
    • Runs automatically on your staged changes before every commit
    • Includes linting and formatting via ruff
    • To check the whole repo, run poetry run pre-commit run --all-files
      • Settings and documentation links for pre-commit and ruff are in .pre-commit-config.yaml and ruff.toml
      • Pre-commit will run automatically during CI, linting and formatting the entire repository.

Testing

Tests are run with poetry run pytest

Test output will be in tests/test_output/

Example Projects

Example projects leveraging this library will be shared shortly.

Release Instructions

  1. Create a branch named Release 0.x.y
  2. Update version in pyproject.toml
  3. Update CHANGELOG using GitHub's "Autogenerate Change Log" feature, using develop as the target
  4. After tests pass, squash merge branch into develop
  5. From local command line, merge develop into main with: git switch main; git pull; git merge --ff-only origin develop; git push
  6. In GitHub, tag the release. Copy and paste the changelog entry into the notes. Verify the release is posted to PyPI.

License

This package is released under the BSD-3-Clause License. See the LICENSE file for details.

Contact

For questions or issues on the URBANopt DES project, please open a GitHub Issue or reach out to the URBANopt DES team at URBANopt DES Support. General URBANopt documentation can be found at https://docs.urbanopt.net.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Latest release

2 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for kflemin from gravatar.com kflemin Avatar for nlong from gravatar.com nlong

Credits

Author: Nicholas Long

Requires

Python <3.14, >=3.10

Classifiers

Report project as malware

Download files

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

Source Distribution

urbanopt_des-0.3.0.tar.gz (10.0 MB view details)

Uploaded Source

Built Distribution

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

urbanopt_des-0.3.0-py3-none-any.whl (10.2 MB view details)

Uploaded Python 3

File details

Details for the file urbanopt_des-0.3.0.tar.gz.

File metadata

  • Download URL: urbanopt_des-0.3.0.tar.gz
  • Upload date:
  • Size: 10.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for urbanopt_des-0.3.0.tar.gz
Algorithm Hash digest
SHA256 f4fefab19dcddfd121bf3beb1da5c702a0302dff115fd2923d114801c69a63a6
MD5 f2f31a4a7c52e31d2c8b440530efb0ec
BLAKE2b-256 0de1788c27bd2de11033e77293e30198b8d25838246d99570305f50199bbf2b6

See more details on using hashes here.

Provenance

The following attestation bundles were made for urbanopt_des-0.3.0.tar.gz:

Publisher: pypi_release.yml on urbanopt/urbanopt-des

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file urbanopt_des-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: urbanopt_des-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 10.2 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for urbanopt_des-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 1e5fba67c95c80c7b0c4f00337235e17024bb4737d31b63c5bd3392b9662a288
MD5 e16cee4526db7a78af92abc81da50c5c
BLAKE2b-256 0e7bc714137bdc663216442c0c57737e0a17bd82564919fa86b4342e012175be

See more details on using hashes here.

Provenance

The following attestation bundles were made for urbanopt_des-0.3.0-py3-none-any.whl:

Publisher: pypi_release.yml on urbanopt/urbanopt-des

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

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