Skip to main content

Translate floor plan geometry into building energy models

Project description

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!

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

plan2eplus-0.1.5.tar.gz (60.1 kB view details)

Uploaded Source

Built Distribution

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

plan2eplus-0.1.5-py3-none-any.whl (103.7 kB view details)

Uploaded Python 3

File details

Details for the file plan2eplus-0.1.5.tar.gz.

File metadata

  • Download URL: plan2eplus-0.1.5.tar.gz
  • Upload date:
  • Size: 60.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","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}

File hashes

Hashes for plan2eplus-0.1.5.tar.gz
Algorithm Hash digest
SHA256 9b9d9de6af121e8f14e7ad0e0e0ef8aa2109e44f147bd5d9deb90695c586bd03
MD5 cf4b4d4f41ca8b5b91f73d7f45626401
BLAKE2b-256 99eed5bf66eef5fbd8e7a9f5b10f6b537b28c8e57183a7173e3d532b6cd8a683

See more details on using hashes here.

File details

Details for the file plan2eplus-0.1.5-py3-none-any.whl.

File metadata

  • Download URL: plan2eplus-0.1.5-py3-none-any.whl
  • Upload date:
  • Size: 103.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.10.4 {"installer":{"name":"uv","version":"0.10.4","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}

File hashes

Hashes for plan2eplus-0.1.5-py3-none-any.whl
Algorithm Hash digest
SHA256 9f447e0fa128c0a7db7cc1cf1b288f23728eed53281c4d704de905669fb83240
MD5 12217e4b8e95b33bc3ffa2eded7a7e2d
BLAKE2b-256 6fbe17170c5edc93b5a4df80e6b3da4e1b67d2e802eee83cbd39c0e17d6ea418

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