[](https://github.com/samuelduchesne/archetypal/actions/workflows/python-package.yml)
[](https://coveralls.io/github/samuelduchesne/archetypal)
[](https://archetypal.readthedocs.io/en/latest/?badge=latest)
[](https://doi.org/10.21105/joss.01833)
[](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:
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](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
1. Clone this repo locally
```console
git clone https://github.com/samuelduchesne/archetypal.git
```
2. Install dependencies:
```console
cd archetypal
conda env create
```
This will create a new environment named `archetypal`. Don't forget to activate the environment.
3. Run Tests:
```console
python -m pytest tests/
```
4. Generate Documentation:
```console
make html
```
Raw data
{
"_id": null,
"home_page": "https://github.com/samuelduchesne/archetypal",
"name": "archetypal",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "Building archetypes",
"author": "Samuel Letellier-Duchesne",
"author_email": "samuel.letellier-duchesne@polymtl.ca",
"download_url": "https://files.pythonhosted.org/packages/5c/08/3240ea6e853b878ec3ce16688f1d0e8f81938042cd7d946c79ab23734014/archetypal-2.17.8.tar.gz",
"platform": null,
"description": "[](https://github.com/samuelduchesne/archetypal/actions/workflows/python-package.yml)\n[](https://coveralls.io/github/samuelduchesne/archetypal)\n[](https://archetypal.readthedocs.io/en/latest/?badge=latest)\n[](https://doi.org/10.21105/joss.01833)\n[](https://github.com/psf/black)\n\n# Archetypal\n\n**python for building simulation archetypes**\n\nRetrieve, construct, simulate, convert and analyze building simulation\ntemplates\n\n## Overview\n\n**Archetypal** is a Python package that helps handle building\narchetypes.\n\n## Changes since v2.0.0\n\nThe conversion of [EnergyPlus](https://energyplus.net) IDF models to\nTrnsys\n[TrnBuild](http://www.trnsys.com/features/suite-of-tools.php.html)\nModels (compatible with the multizone building model) is now part of a\ndistinct package known as the\n[trnslator](https://github.com/louisleroy5/trnslator).\n\n## Features\n\nHere is a short overview of features that are part of archetypal:\n\n1. Building Complexity Reduction: A utility to transform a multizone\n EnergyPlus model to a two-zone normalized model. Such models are\n called `building archetypes` and are the foundation of the\n [UMI Energy Module](https://umidocs.readthedocs.io/en/latest/docs/model-setup-template.html).\n This tool will allow any EnergyPlus model to be imported into\n [UMI](http://web.mit.edu/sustainabledesignlab/projects/umi/index.html)\n and drastically speedup the UBEM process.\n\n## Installation\n\nRecommended to use a conda environement running python 3.8. Pip install should work on all platforms (linux, macOS and Windows).\nFirst,\n```cmd\nconda create -n venv python=3.8\n``` \n`-n venv` is the name of your environement; it can be anything.\nThen,\n```cmd\npip install -U archetypal\n```\n\n## Local Development\n\n1. Clone this repo locally\n\n```console\ngit clone https://github.com/samuelduchesne/archetypal.git\n```\n\n2. Install dependencies:\n\n```console\ncd archetypal\nconda env create\n```\n\nThis will create a new environment named `archetypal`. Don't forget to activate the environment.\n\n3. Run Tests:\n\n```console\npython -m pytest tests/\n```\n\n4. Generate Documentation:\n\n```console\nmake html\n```\n\n",
"bugtrack_url": null,
"license": "MIT License",
"summary": "Retrieve, construct, simulate, convert and analyse building archetypes",
"version": "2.17.8",
"project_urls": {
"Homepage": "https://github.com/samuelduchesne/archetypal"
},
"split_keywords": [
"building",
"archetypes"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2d313b65aa77f2d14541a47873c0799a66d6e140a6671403d91e53d9eab8355d",
"md5": "bf1c86d0657f5642f182378596e862dd",
"sha256": "590896596180f64c92d08d0b62e42d86c64fbd33354a46c7f263f3dc6d96baa2"
},
"downloads": -1,
"filename": "archetypal-2.17.8-py3-none-any.whl",
"has_sig": false,
"md5_digest": "bf1c86d0657f5642f182378596e862dd",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 254078,
"upload_time": "2024-01-09T00:07:05",
"upload_time_iso_8601": "2024-01-09T00:07:05.719370Z",
"url": "https://files.pythonhosted.org/packages/2d/31/3b65aa77f2d14541a47873c0799a66d6e140a6671403d91e53d9eab8355d/archetypal-2.17.8-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "5c083240ea6e853b878ec3ce16688f1d0e8f81938042cd7d946c79ab23734014",
"md5": "3548fd7a2707571eb844873d933a0461",
"sha256": "43c7e16fa8ad593a52b801fb63594ce5cbd0f3275e1a3bb83d2c2146beaf9d26"
},
"downloads": -1,
"filename": "archetypal-2.17.8.tar.gz",
"has_sig": false,
"md5_digest": "3548fd7a2707571eb844873d933a0461",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 12160097,
"upload_time": "2024-01-09T00:07:08",
"upload_time_iso_8601": "2024-01-09T00:07:08.437148Z",
"url": "https://files.pythonhosted.org/packages/5c/08/3240ea6e853b878ec3ce16688f1d0e8f81938042cd7d946c79ab23734014/archetypal-2.17.8.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-01-09 00:07:08",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "samuelduchesne",
"github_project": "archetypal",
"travis_ci": false,
"coveralls": true,
"github_actions": true,
"requirements": [],
"lcname": "archetypal"
}
JSON
