Metadata-Version: 2.4
Name: epinterface
Version: 1.5.0
Summary: This is a repository for dynamically generating energy models within Python, relying on Archetypal and Eppy for most of its functionality.
Project-URL: Homepage, https://github.com/szvsw/epinterface
Project-URL: Documentation, https://szvsw.github.io/epinterface
Project-URL: Repository, https://github.com/szvsw/epinterface
Project-URL: Issues, https://github.com/szvsw/epinterface/issues
Author-email: Sam Wolk <mail@samwolk.info>
License-File: LICENSE
Requires-Python: <3.13,>=3.10
Requires-Dist: archetypal==2.18.10
Requires-Dist: click==8.1.7
Requires-Dist: geopandas~=1.0.1
Requires-Dist: httpx~=0.27.2
Requires-Dist: ladybug-core>=0.44.30
Requires-Dist: openpyxl~=3.1.5
Requires-Dist: pandas<2.3,>=2.2
Requires-Dist: prisma~=0.15.0
Requires-Dist: pydantic-settings<3,>=2.0
Requires-Dist: pydantic<3,>=2.9
Requires-Dist: pythermalcomfort>=3.8.0
Description-Content-Type: text/markdown

# epinterface

[![Release](https://img.shields.io/github/v/release/szvsw/epinterface)](https://img.shields.io/github/v/release/szvsw/epinterface)
[![Build status](https://img.shields.io/github/actions/workflow/status/szvsw/epinterface/main.yml?branch=main)](https://github.com/szvsw/epinterface/actions/workflows/main.yml?query=branch%3Amain)
[![codecov](https://codecov.io/gh/szvsw/epinterface/branch/main/graph/badge.svg)](https://codecov.io/gh/szvsw/epinterface)
[![Commit activity](https://img.shields.io/github/commit-activity/m/szvsw/epinterface)](https://img.shields.io/github/commit-activity/m/szvsw/epinterface)
[![License](https://img.shields.io/github/license/szvsw/epinterface)](https://img.shields.io/github/license/szvsw/epinterface)

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

- **Github repository**: <https://github.com/szvsw/epinterface/>

## 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.

- **Documentation** <https://szvsw.github.io/epinterface/>

## Getting started with your project

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

```bash
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

```bash
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](https://fpgmaas.github.io/cookiecutter-uv/features/publishing/#set-up-for-pypi).
For activating the automatic documentation with MkDocs, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/mkdocs/#enabling-the-documentation-on-github).
To enable the code coverage reports, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/codecov/).

## Releasing a new version

- Create an API Token on [PyPI](https://pypi.org/).
- Add the API Token to your projects secrets with the name `PYPI_TOKEN` by visiting [this page](https://github.com/szvsw/epinterface/settings/secrets/actions/new).
- Create a [new release](https://github.com/szvsw/epinterface/releases/new) on Github.
- Create a new tag in the form `*.*.*`.
- For more details, see [here](https://fpgmaas.github.io/cookiecutter-uv/features/cicd/#how-to-trigger-a-release).

---

Repository initiated with [fpgmaas/cookiecutter-uv](https://github.com/fpgmaas/cookiecutter-uv).
