Skip to main content

Retrieve, construct, simulate, convert and analyse building archetypes

Project description

[![Build Status](]( [![Coverage Status](]( [![Documentation Status](]( [![DOI](]( [![Code style: black](](

# Archetypal

python for building simulation archetypes

Retrieve, construct, simulate, convert and analyze building simulation templates

## Overview

Archetypal is a Python package that helps handle building archetypes.

## Changes since v2.0.0

The conversion of [EnergyPlus]( IDF models to Trnsys [TrnBuild]( Models (compatible with the multizone building model) is now part of a distinct package known as the [trnslator](

## Features

Here is a short overview of features that are part of archetypal:

  1. Building Complexity Reduction: A utility to transform a multizone EnergyPlus model to a two-zone normalized model. Such models are called building archetypes and are the foundation of the [UMI Energy Module]( This tool will allow any EnergyPlus model to be imported into [UMI]( and drastically speedup the UBEM process.

## Installation

Recommended to use a conda environement running python 3.8. Pip install should work on all platforms (linux, macOS and Windows). First, `cmd conda create -n venv python=3.8 ` -n venv is the name of your environement; it can be anything. Then, `cmd pip install -U archetypal `

## Local Development

  1. Clone this repo locally

`console git clone `

  1. Install dependencies:

`console cd archetypal conda env create `

This will create a new environment named archetypal. Don’t forget to activate the environment.

  1. Run Tests:

`console python -m pytest tests/ `

  1. Generate Documentation:

`console make html `

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

archetypal-2.16.1.tar.gz (12.2 MB view hashes)

Uploaded source

Built Distribution

archetypal-2.16.1-py3-none-any.whl (253.1 kB view hashes)

Uploaded py3

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page