| Name | archetypal JSON |
| Version |
2.18.3
JSON |
| download |
| home_page | None |
| Summary | Retrieve, construct, simulate, convert and analyse building archetypes |
| upload_time | 2024-09-19 20:30:52 |
| maintainer | None |
| docs_url | None |
| author | Samuel Letellier-Duchesne |
| requires_python | <4.0,>=3.9 |
| license | MIT |
| keywords |
|
| VCS |
|
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
[](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": null,
"name": "archetypal",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": null,
"author": "Samuel Letellier-Duchesne",
"author_email": "samuelduchesne@me.com",
"download_url": "https://files.pythonhosted.org/packages/6e/30/505a5d6af67e6ab258b692fc8b8b7fd7104f1cb62a9d4128965e13f5187e/archetypal-2.18.3.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\n```cmd\nconda create -n venv python=3.8\n```\n\n`-n venv` is the name of your environement; it can be anything.\nThen,\n\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",
"bugtrack_url": null,
"license": "MIT",
"summary": "Retrieve, construct, simulate, convert and analyse building archetypes",
"version": "2.18.3",
"project_urls": null,
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "637a99bea275ad30f2d6b47247d7d51bd6e9b53e4bb8985f769755e82d2a8f18",
"md5": "5761b4ce5cd2d3396f0ee58ea0a16860",
"sha256": "76b68a4ecd3f24a1a5949b364a68d7ca26c018a1ef77f79f6ca3db4698c99681"
},
"downloads": -1,
"filename": "archetypal-2.18.3-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5761b4ce5cd2d3396f0ee58ea0a16860",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 287365,
"upload_time": "2024-09-19T20:30:49",
"upload_time_iso_8601": "2024-09-19T20:30:49.922310Z",
"url": "https://files.pythonhosted.org/packages/63/7a/99bea275ad30f2d6b47247d7d51bd6e9b53e4bb8985f769755e82d2a8f18/archetypal-2.18.3-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "6e30505a5d6af67e6ab258b692fc8b8b7fd7104f1cb62a9d4128965e13f5187e",
"md5": "2772e61fa57a360ecbb3316dde170c68",
"sha256": "9011c92e04afad6e52b9d6ae33233d5ad8a25fe3a294ad1c97a0daaee9b7b090"
},
"downloads": -1,
"filename": "archetypal-2.18.3.tar.gz",
"has_sig": false,
"md5_digest": "2772e61fa57a360ecbb3316dde170c68",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 240990,
"upload_time": "2024-09-19T20:30:52",
"upload_time_iso_8601": "2024-09-19T20:30:52.016647Z",
"url": "https://files.pythonhosted.org/packages/6e/30/505a5d6af67e6ab258b692fc8b8b7fd7104f1cb62a9d4128965e13f5187e/archetypal-2.18.3.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-19 20:30:52",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "archetypal"
}
