Skip to content

Latest commit

 

History

History
35 lines (21 loc) · 1.58 KB

README.md

File metadata and controls

35 lines (21 loc) · 1.58 KB

GeomEppy

Build Status for Python 2.7, 3.7 via Travis

CodeCov via CodeCov

Documentation Status on Read the Docs

GeomEppy is a scripting language for use with Eppy, which in turn is a scripting language for EnergyPlus IDF files and output files.

It primarily adds functions to do with IDF geometry, including zones, surfaces, constructions, etc.

Installation

In most cases, all that is needed is:

pip install geomeppy

If you have problems installing, you may need to install shapely first. To ensure the required libraries are installed, we recommend installing shapely using a conda environment, particularly on Windows.

Documentation

Complete documentation is hosted at Read the Docs. This covers the internals of geomeppy, and may be subject to change.

Features documented in the Basics section can be relied upon to remain stable.

Referencing

If you rely on this package in academic work, and would like to include a citation (which we greatly appreciate), please refer to this project as: