Skip to main content

This is a repository for dynamically generating energy models within Python, relying on Archetypal and Eppy for most of its functionality.

Project description

epinterface

Release Build status codecov Commit activity License

This is a repository for dynamically generating energy models within Python, relying on Archetypal and Eppy for most of its functionality.

Configuration

The EnergyPlus version used when creating IDF objects can be configured via the EPINTERFACE_ENERGYPLUS_VERSION environment variable. It defaults to 22.2.0. Both dotted (22.2.0) and hyphenated (22-2-0) version formats are accepted.

Getting started with your project

First, create a repository on GitHub with the same name as this project, and then run the following commands:

git init -b main
git add .
git commit -m "init commit"
git remote add origin git@github.com:szvsw/epinterface.git
git push -u origin main

Finally, install the environment and the pre-commit hooks with

make install

You are now ready to start development on your project! The CI/CD pipeline will be triggered when you open a pull request, merge to main, or when you create a new release.

To finalize the set-up for publishing to PyPI or Artifactory, see here. For activating the automatic documentation with MkDocs, see here. To enable the code coverage reports, see here.

Releasing a new version

  • Create an API Token on PyPI.
  • Add the API Token to your projects secrets with the name PYPI_TOKEN by visiting this page.
  • Create a new release on Github.
  • Create a new tag in the form *.*.*.
  • For more details, see here.

Repository initiated with fpgmaas/cookiecutter-uv.

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

epinterface-1.3.0.tar.gz (6.0 MB view details)

Uploaded Source

Built Distribution

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

epinterface-1.3.0-py3-none-any.whl (882.7 kB view details)

Uploaded Python 3

File details

Details for the file epinterface-1.3.0.tar.gz.

File metadata

  • Download URL: epinterface-1.3.0.tar.gz
  • Upload date:
  • Size: 6.0 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.6.14

File hashes

Hashes for epinterface-1.3.0.tar.gz
Algorithm Hash digest
SHA256 517aac62534cad83e9ffa19ed3cc364f6745eb04089b1bfd99c63f2425380d26
MD5 cdd64148a45979bee0833f25987b1a7d
BLAKE2b-256 64ec2088293d4017a4bafb48ae4a5d586f462024a53aac2de28af954ebe1ae3e

See more details on using hashes here.

File details

Details for the file epinterface-1.3.0-py3-none-any.whl.

File metadata

File hashes

Hashes for epinterface-1.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9071acbf8f309f79332a6d78220e85a82b173116bf8ce31864149d9c6ad9c76a
MD5 c43d2187b47876251f22cf7feac2c88d
BLAKE2b-256 7adf102d56f84cf4ce9d260babb9f7c60e006fc7394fe1b75fc7a052b1551d21

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