Data

Tools

Indexes

Applications

Experiments

Open Source Science

OpenTerrace

OpenTerrace: A fast, flexible and extendable Python framework for thermal energy storage packed bed simulations - Published in JOSS (2024)

https://github.com/openterrace/openterrace-python

Science Score: 98.0%

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

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

Keywords

carnot-battery energy-storage heat-transfer multiphase-flow numerical packed-bed phase-change-materials python
Last synced: 4 months ago · JSON representation ·

Repository

OpenTerrace: A fast, flexible and extendable Python framework for packed bed thermal energy storage simulations

Basic Info
Statistics
  • Stars: 22
  • Watchers: 1
  • Forks: 3
  • Open Issues: 0
  • Releases: 14
Topics
carnot-battery energy-storage heat-transfer multiphase-flow numerical packed-bed phase-change-materials python
Created almost 4 years ago · Last pushed 10 months ago
Metadata Files
Readme Contributing License Citation

README.md

PyPI - Version PyPI - Downloads PyPI - Python Version GitHub Actions Workflow Status GitHub Actions Workflow Status GitHub Issues status

Logo

OpenTerrace is a pure Python framework for packed bed thermal energy storage simulations. It is built from the ground up to be flexible and extendable on modern Python 3.x with speed in mind.

OpenTerrace uses awesome open-source software such as Numba, NumPy and SciPy.

Read the documentation of OpenTerrace

Why OpenTerrace?

  • FAST
    By making use of modern compilers and optimised tri-diagonal matrix solvers, OpenTerrace is built to be fast.

  • FLEXIBLE
    OpenTerrace is built from the ground up to be flexible for easy integration in system models or optimisation loops.

  • EXTENDABLE
    Modules for new materials such as non-spherical rocks or exotic Phase Change Materials (PCM) can easily be plugged into the OpenTerrace framework.

Want to contribute?

Contributions are most welcome! Feel free to send pull requests or get in touch to discuss how to collaborate.

JOSS Publication

OpenTerrace: A fast, flexible and extendable Python framework for thermal energy storage packed bed simulations
Published
June 04, 2024
DOI
Volume 9, Issue 98, Page 6411
Authors
Jakob Hærvig ORCID
Aalborg University, Denmark
Editor
Adam R. Jensen ORCID
Tags
Heat transfer Energy storage Packed bed Phase change materials
View PDF Review Thread Software Archive

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use OpenTerrace, please cite it as below."
preferred-citation:
  type: "article"
  authors:
  - family-names: "Hærvig"
    given-names: "Jakob"
    orcid: "https://orcid.org/0000-0001-8710-1610"
  date-published: 2024-06-04
  doi: 10.21105/joss.06411
  issn: 2475-9066
  issue: 98
  journal: Journal of Open Source Software
  publisher:
    name: Open Journals
  start: 6411
  title: "OpenTerrace: A fast, flexible and extendable Python framework
    for thermal energy storage packed bed simulations"
  journal: "Journal of Open Source Software"
  issue: 98
  volume: 9
  start: 6411
  url: "https://github.com/OpenTerrace/openterrace-python"
title: "OpenTerrace: A fast, flexible and extendable Python framework
  for thermal energy storage packed bed simulations"

GitHub Events

Total
  • Issues event: 1
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 3
  • Push event: 21
  • Pull request event: 4
  • Fork event: 2
  • Create event: 1
Last Year
  • Issues event: 1
  • Watch event: 1
  • Delete event: 1
  • Issue comment event: 3
  • Push event: 21
  • Pull request event: 4
  • Fork event: 2
  • Create event: 1

Committers

Last synced: 5 months ago

All Time
  • Total Commits: 584
  • Total Committers: 4
  • Avg Commits per committer: 146.0
  • Development Distribution Score (DDS): 0.365
Past Year
  • Commits: 5
  • Committers: 1
  • Avg Commits per committer: 5.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Jakob Hærvig j****g@g****m 371
Jakob Hærvig 1****g 211
Kyle Niemeyer k****r@f****m 1
Adam R. Jensen 3****n 1
Committer Domains (Top 20 + Academic)
fastmail.com: 1

Issues and Pull Requests

Last synced: 4 months ago

All Time
  • Total issues: 23
  • Total pull requests: 188
  • Average time to close issues: 10 days
  • Average time to close pull requests: 28 minutes
  • Total issue authors: 4
  • Total pull request authors: 3
  • Average comments per issue: 2.48
  • Average comments per pull request: 0.04
  • Merged pull requests: 186
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 1
  • Pull requests: 3
  • Average time to close issues: about 2 hours
  • Average time to close pull requests: less than a minute
  • Issue authors: 1
  • Pull request authors: 1
  • Average comments per issue: 4.0
  • Average comments per pull request: 0.0
  • Merged pull requests: 3
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • AdamRJensen (16)
  • baperry2 (3)
  • Konsilion (1)
  • Eheran1 (1)
Pull Request Authors
  • jakobhaervig (255)
  • AdamRJensen (5)
  • kyleniemeyer (2)
Top Labels
Issue Labels
Pull Request Labels

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 30 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 0
  • Total versions: 14
  • Total maintainers: 1
pypi.org: openterrace

OpenTerrace: A fast, flexible and extendable Python framework for packed bed thermal energy storage simulations

  • Versions: 14
  • Dependent Packages: 0
  • Dependent Repositories: 0
  • Downloads: 30 Last month
Rankings
Dependent packages count: 6.6%
Stargazers count: 19.5%
Average: 24.2%
Forks count: 30.5%
Dependent repos count: 30.6%
Downloads: 33.7%
Maintainers (1)
jakobhaervig
Last synced: 4 months ago

Dependencies

.github/workflows/PyPi.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
.github/workflows/docs.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
.github/workflows/testPyPi.yml actions
  • actions/checkout v3 composite
  • actions/setup-python v3 composite
.github/workflows/tests.yml actions
  • actions/checkout v2 composite
  • actions/setup-python v2 composite
pyproject.toml pypi
  • pytest ^5.2 develop
  • matplotlib ^3.6.1
  • numba ^0.56.3
  • numpy ^1.23.4
  • pandas ^1.5.2
  • pytest ^7.1.3
  • python ^3.9
  • scipy ^1.9.3
  • tqdm ^4.64.1
.github/workflows/upToDateDev.yml actions
  • actions/checkout v3 composite
.github/workflows/draft-pdf.yml actions
  • actions/checkout v4 composite
  • actions/upload-artifact v1 composite
  • openjournals/openjournals-draft-action master composite