plan2eplus
plan2eplus makes it easy to translate floor plan geometry into building energy models
plan2eplus is a Python library designed for authoring building energy models, with the aim of helping designers better understand the energy consumption and thermal performance of proposed building during the early stages of design. plan2eplus is designed for EnergyPlus, a popular software for creating building energy models.
plan2eplus provides support for:
- Translating validated geometric information into EnergyPlus models
- Studying the impact of natural ventilation on thermal performance using EnergyPlus's AirflowNetwork
- Quickly visualizing input geometries as 2D plans
- Studying the impact of different floor plans on thermal performance
About
Typical methods for creating an energy model for a given floor plan can be slow and error-prone. In a typical workflow, one might obtain the dimensions of the geometries of the components of their floorplan, redraw the geometry based on these dimensions, and then have another program generate the energy model. plan2eplus relieves the need to redraw geometries, making it possible for users to go directly from dimensions of the plan to energy models. The package exposes a series of user friendly objects that can either be defined in Python or in JSON files, making it easy bring geometric information from a variety of venues.
plan2eplus is designed for early-stage, climate-aware architecture. As such, support for EnergyPlus's AirflowNetwork, which enables users to understand the potential benefits of using natural ventilation, is a first-order consideration. plan2eplus also provides methods for visualizing floor plans and various quantities of interest, enabling designers to quickly understand how their chosen design affects thermal performance. As part of this goal, plan2eplus also provides functionality to quickly generate a series of different designs and study the impact of changes.
Install
You can install plan2eplus using uv or pip:
# with uv
uv add plan2eplus
# with pip
pip install plan2eplus
plan2eplus provides an interface to EnergyPlus, making it easy to author EnergyPlus models. In order to run energy models on your device, you will need a local installation on EnergyPlus. You can download EnergyPlus here. Note: currently, plan2eplus has only been tested using EnergyPlus 22.1.
Usage
Below is a basic example of a workflow for creating a simple model with two adjacent rooms. For more examples, please refer to the (forthcoming) documentation.
from replan2eplus.ezcase.ez import EZ
from replan2eplus.ops.zones.user_interface import Room
from replan2eplus.geometry.domain import Domain
from replan2eplus.geometry.range import Range
# define geometry - all values are in meters
domain1 = Domain(horz_range=Range(0,1), vert_range=Range(0,1))
domain2 = Domain(horz_range=Range(1,2), vert_range=Range(0,1))
height = 3.00
# define rooms
room1 = Room(id=0, name="room1", domain1, height)
room2 = Room(id=1, name="room2", domain2, height)
rooms = [room1, room2]
# define the case
case = (
EZ()
.add_zones(rooms)
.add_constructions()
)
# run the case
case.save_and_run(run=True)
Contributing
Please contact jnwagwu@stanford.edu if you are interested in helping to make plan2eplus better!
Metadata
Release files for plan2eplus 0.1.6
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| plan2eplus-0.1.6.tar.gz | 60.2 kB | Without provenance | Details for plan2eplus-0.1.6.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| plan2eplus-0.1.6-py3-none-any.whl | Python 3 | none | any | Details for plan2eplus-0.1.6-py3-none-any.whl |
Total release size: 164.4 kB
Release files / plan2eplus-0.1.6.tar.gz
| Download URL | plan2eplus-0.1.6.tar.gz |
|---|---|
| Size | 60.2 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
538fe5d37e8920fd4869755c2138297846901ffd95ad97a1b3fbf405663d39a3
|
|
BLAKE2b-256 checksum How to use checksums |
5a39369599596c0723f824725df1e1bcac1c8c4f32fdd4b30c7883102ae58cee
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Release files / plan2eplus-0.1.6-py3-none-any.whl
| Download URL | plan2eplus-0.1.6-py3-none-any.whl |
|---|---|
| Size | 104.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
51a6dcbacf6aaa712ca7aab8b845500eccb682e6cba5309f905e930dda314617
|
|
BLAKE2b-256 checksum How to use checksums |
de82b99f3ddfe0783e0535efe774064cbbf2ee3a96f37c2ec8aa8958eb9ef45a
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
uv/0.10.9 {"installer":{"name":"uv","version":"0.10.9","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
|
Security for plan2eplus 0.1.6
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.