Retrieve, construct, simulate, convert and analyse building archetypes
Project description
[![Build Status](https://github.com/samuelduchesne/archetypal/actions/workflows/python-package.yml/badge.svg?branch=main)](https://github.com/samuelduchesne/archetypal/actions/workflows/python-package.yml) [![Coverage Status](https://coveralls.io/repos/github/samuelduchesne/archetypal/badge.svg)](https://coveralls.io/github/samuelduchesne/archetypal) [![Documentation Status](https://readthedocs.org/projects/archetypal/badge/?version=latest)](https://archetypal.readthedocs.io/en/latest/?badge=latest) [![DOI](https://joss.theoj.org/papers/10.21105/joss.01833/status.svg)](https://doi.org/10.21105/joss.01833) [![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/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](https://energyplus.net) IDF models to Trnsys [TrnBuild](http://www.trnsys.com/features/suite-of-tools.php.html) Models (compatible with the multizone building model) is now part of a distinct package known as the [trnslator](https://github.com/louisleroy5/trnslator).
## Features
Here is a short overview of features that are part of archetypal:
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](https://umidocs.readthedocs.io/en/latest/docs/model-setup-template.html). This tool will allow any EnergyPlus model to be imported into [UMI](http://web.mit.edu/sustainabledesignlab/projects/umi/index.html) 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
Clone this repo locally
`console git clone https://github.com/samuelduchesne/archetypal.git `
Install dependencies:
`console cd archetypal conda env create `
This will create a new environment named archetypal. Don’t forget to activate the environment.
Run Tests:
`console python -m pytest tests/ `
Generate Documentation:
`console make html `
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for archetypal-2.13.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f5fc98a207f5d94958005c8713faf39ab297aa282aeea04c025f093ec62eb45c |
|
MD5 | e41c9ca63dcb98d78486f361edacc578 |
|
BLAKE2b-256 | 2657764ccca42af38db482486f64f379f17a03bff77770625c2cfad604ab50b9 |