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.4.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.4.0-py3-none-any.whl (883.2 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: epinterface-1.4.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.4.0.tar.gz
Algorithm Hash digest
SHA256 4c880d917cc0aed3cb49cdfcee1f255bd6bfcaeab381a903d48310af6499cd06
MD5 f6cc53d076683df2772d6b30ab9e4d46
BLAKE2b-256 b845163ac4e8fcd92d94cb223fad8a66a17b7f408e1c0964ab8ff49af500f1b8

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for epinterface-1.4.0-py3-none-any.whl
Algorithm Hash digest
SHA256 6fabc96b9fa6cfb6d3609c5a06ae6071e5ad3a3519123a3f3f29dd991178cb4f
MD5 5a489426dc3f012cb113dd6afafa2d9d
BLAKE2b-256 957984f389e491fff2e701de506f1034c81f41b7c28cea2d8ab6f49e172e2c2c

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