Skip to main content

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,

conda create -n venv python=3.8

-n venv is the name of your environement; it can be anything. Then,

pip install -U archetypal

Local Development

  1. Clone this repo locally
git clone https://github.com/samuelduchesne/archetypal.git
  1. Install dependencies:
cd archetypal
conda env create

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

  1. Run Tests:
python -m pytest tests/
  1. Generate Documentation:
make html

Metadata

Release files for archetypal 2.18.10

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for archetypal 2.18.10
File Size Uploaded
archetypal-2.18.10.tar.gz 237.8 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for archetypal 2.18.10
File Interpreter ABI Platform
archetypal-2.18.10-py3-none-any.whl Python 3 none any Details

Total release size: 526.9 kB

Release files / archetypal-2.18.10.tar.gz

Download URL archetypal-2.18.10.tar.gz
Size 237.8 kB
Tags Source
SHA-256 checksum
How to use checksums
fca2698762c36a2ed02faa00a33ad55da66ab01cc1b7ed8c3d86a12a82082c8a
BLAKE2b-256 checksum
How to use checksums
3be64f52882c31c26d6ca95acd71cf88f8e3d044fe6ed99058dc6e909e16accf
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.3.2 CPython/3.11.14 Linux/6.11.0-1018-azure

Release files / archetypal-2.18.10-py3-none-any.whl

Download URL archetypal-2.18.10-py3-none-any.whl
Size 289.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
43e2d66d0a6b4d617a76dd074b6825f7ebc3a97a89ba4b0adfbdeb4736e9d407
BLAKE2b-256 checksum
How to use checksums
a7c376577d22f946ee26c5b530a21274e36bad1afb2c2048b39353d690058d44
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via poetry/2.3.2 CPython/3.11.14 Linux/6.11.0-1018-azure

Release history Release notifications | RSS feed

This release

2.18.10 This release

2 release files

2.18.8

2 release files

2.18.7

2 release files

2.18.6

2 release files

2.18.5

2 release files

2.18.4

2 release files

2.18.3

2 release files

2.18.1

2 release files

2.18.0

2 release files

2.17.9

2 release files

2.17.6

2 release files

2.17.4

2 release files

2.17.3

2 release files

2.17.2

2 release files

2.17.1

2 release files

2.17.0

2 release files

2.15.2

2 release files

2.13.3

2 release files

2.13.2

2 release files

2.13.1

2 release files

2.13.0

2 release files

2.12.1

2 release files

2.12.0

2 release files

2.11.0

2 release files

2.10.0

2 release files

2.9.4

2 release files

2.9.3

2 release files

2.9.1

2 release files

2.9.0

2 release files

2.8.3

2 release files

2.8.2

2 release files

2.8.1

2 release files

2.8.0

2 release files

2.7.1

2 release files

2.7.0

2 release files

2.6.4

2 release files

2.6.3

2 release files

2.6.2

2 release files

2.6.1

2 release files

2.6.0

2 release files

2.5.0

2 release files

2.4.0

2 release files

2.3.1

2 release files

2.3.0

2 release files

2.2.6

2 release files

2.2.5

2 release files

2.2.3

2 release files

2.2.2

2 release files

2.2.1

2 release files

2.2.0

2 release files

2.1.3

2 release files

2.1.2

2 release files

2.1.1

2 release files

2.1.0

2 release files

2.0.1

2 release files

2.0.0

2 release files

1.3.4

1 release file

1.3.3

1 release file

1.3.2

1 release file

1.3.1

1 release file

1.3.0

2 release files

1.2.6

1 release file

1.2.5

1 release file

1.2.4

1 release file

1.2.2

1 release file

1.2.1

1 release file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page