Data

Tools

Indexes

Applications

Experiments

Open Source Science

archetypal

archetypal: A Python package for collecting, simulating, converting and analyzing building archetypes - Published in JOSS (2020)

https://github.com/samuelduchesne/archetypal

Science Score: 95.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ○
    CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ✓
    DOI references
    Found 4 DOI reference(s) in README and JOSS metadata
  • ✓
    Academic publication links
    Links to: joss.theoj.org
  • ✓
    Committers with academic emails
    1 of 7 committers (14.3%) from academic institutions
  • ○
    Institutional organization owner
  • ✓
    JOSS paper metadata
    Published in Journal of Open Source Software

Keywords

archetypes buildings energy-simulation energyplus energyplus-models python simulation-templates umi umi-template visualization

Keywords from Contributors

mesh

Scientific Fields

Sociology Social Sciences - 87% confidence
Artificial Intelligence and Machine Learning Computer Science - 83% confidence
Last synced: 6 months ago · JSON representation

Repository

archetypal: Retrieve, construct, simulate, convert and analyse building simulation templates

Basic Info
Statistics
  • Stars: 17
  • Watchers: 2
  • Forks: 9
  • Open Issues: 41
  • Releases: 68
Topics
archetypes buildings energy-simulation energyplus energyplus-models python simulation-templates umi umi-template visualization
Created over 7 years ago · Last pushed 7 months ago
Metadata Files
Readme Contributing License

README.md

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 https://github.com/samuelduchesne/archetypal.git

  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

Owner

  • Name: Samuel Letellier-Duchesne
  • Login: samuelduchesne
  • Kind: user
  • Location: NYC
  • Company: @carbon-signal @MITSustainableDesignLab @Elementa-Engineering @Introba

JOSS Publication

archetypal: A Python package for collecting, simulating, converting and analyzing building archetypes
Published
June 08, 2020
DOI
Volume 5, Issue 50, Page 1833
Authors
Samuel Letellier-Duchesne ORCID
Department of Mechanical Engineering, Polytechnique Montréal, Montréal, Canada
Louis Leroy
Department of Mechanical Engineering, Polytechnique Montréal, Montréal, Canada
Editor
Kyle Niemeyer ORCID
Tags
Building Energy Model Archetype Archetype Template EnergyPlus TRNSYS
View PDF Review Thread Software Archive

GitHub Events

Total
  • Create event: 15
  • Release event: 3
  • Issues event: 7
  • Watch event: 5
  • Delete event: 13
  • Issue comment event: 12
  • Push event: 46
  • Pull request review event: 6
  • Pull request event: 33
Last Year
  • Create event: 15
  • Release event: 3
  • Issues event: 7
  • Watch event: 5
  • Delete event: 13
  • Issue comment event: 12
  • Push event: 46
  • Pull request review event: 6
  • Pull request event: 33

Committers

Last synced: 7 months ago

All Time
  • Total Commits: 2,626
  • Total Committers: 7
  • Avg Commits per committer: 375.143
  • Development Distribution Score (DDS): 0.345
Past Year
  • Commits: 25
  • Committers: 1
  • Avg Commits per committer: 25.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Samuel Letellier-Duchesne s****e@m****m 1,719
Unknown l****5@g****m 806
Samuel Letellier-Duchesne s****d@m****u 72
dependabot[bot] 4****] 22
Sam Wolk 3****w 3
zlehong 5****g 2
Zach Berzolla 5****a 2
Committer Domains (Top 20 + Academic)
mit.edu: 1 me.com: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 14
  • Total pull requests: 168
  • Average time to close issues: 4 months
  • Average time to close pull requests: about 2 months
  • Total issue authors: 2
  • Total pull request authors: 4
  • Average comments per issue: 1.21
  • Average comments per pull request: 0.83
  • Merged pull requests: 62
  • Bot issues: 0
  • Bot pull requests: 83
Past Year
  • Issues: 4
  • Pull requests: 36
  • Average time to close issues: about 1 month
  • Average time to close pull requests: 16 days
  • Issue authors: 2
  • Pull request authors: 2
  • Average comments per issue: 2.0
  • Average comments per pull request: 0.11
  • Merged pull requests: 23
  • Bot issues: 0
  • Bot pull requests: 5
View more stats
Top Authors
Issue Authors
  • szvsw (8)
  • samuelduchesne (5)
Pull Request Authors
  • samuelduchesne (91)
  • dependabot[bot] (86)
  • szvsw (8)
  • zlehong (3)
Top Labels
Issue Labels
bug (5) enhancement (1) invalid (1)
Pull Request Labels
dependencies (99) bug (30) refactoring (16) enhancement (9) codex (4) new feature (3)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 1,664 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 2
  • Total versions: 76
  • Total maintainers: 1
pypi.org: archetypal

Retrieve, construct, simulate, convert and analyse building archetypes

  • Versions: 76
  • Dependent Packages: 0
  • Dependent Repositories: 2
  • Downloads: 1,664 Last month
Rankings
Downloads: 6.8%
Dependent packages count: 7.3%
Average: 10.9%
Dependent repos count: 11.8%
Forks count: 12.0%
Stargazers count: 16.6%
Maintainers (1)
samueld
Last synced: 6 months ago

Dependencies

.github/workflows/python-package.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v4 composite
  • codecov/codecov-action v1 composite
.github/workflows/python-publish.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
Dockerfile docker
  • scottyhardy/docker-wine latest build
environment.yml pypi
  • CoolProp *
  • deprecation *
  • energy-pandas *
  • eppy ==0.5.56
  • geomeppy ==0.11.8
  • setuptools *
  • sigfig *
  • validator_collection *
requirements-dev.txt pypi
  • autodoc-pydantic * development
  • pytest * development
  • pytest-cov * development
  • recommonmark * development
  • sphinx * development
  • sphinx-click * development
  • sphinx_rtd_theme * development
requirements.txt pypi
  • CoolProp *
  • click *
  • deprecation *
  • energy-pandas *
  • eppy ==0.5.60
  • matplotlib *
  • networkx *
  • numpy >=1.17
  • outdated *
  • packaging *
  • pandas >=1.2.0
  • path *
  • pint ==0.19
  • pycountry *
  • pydantic *
  • pytest *
  • requests *
  • scikit-learn *
  • setuptools *
  • sigfig *
  • tabulate *
  • tqdm *
  • typing_extensions ==4.3.0
  • validator_collection *
setup.py pypi
  • r.strip *