Data

Tools

Indexes

Applications

Experiments

Open Source Science

airpeak

https://github.com/epfl-hobel/airpeak

Science Score: 75.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 7 DOI reference(s) in README
  • ✓
    Academic publication links
    Links to: zenodo.org
  • ○
    Academic email domains
  • ✓
    Institutional organization owner
    Organization epfl-hobel has institutional domain (www.epfl.ch)
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (12.6%) to scientific vocabulary
Last synced: 6 months ago · JSON representation ·

Repository

Basic Info
  • Host: GitHub
  • Owner: EPFL-HOBEL
  • License: gpl-3.0
  • Language: Jupyter Notebook
  • Default Branch: main
  • Size: 1.57 MB
Statistics
  • Stars: 4
  • Watchers: 1
  • Forks: 0
  • Open Issues: 1
  • Releases: 4
Created 10 months ago · Last pushed 8 months ago
Metadata Files
Readme License Citation

README.md

GitHub License <!-- ALL-CONTRIBUTORS-BADGE:START - Do not remove or modify this section -->All Contributors<!-- ALL-CONTRIBUTORS-BADGE:END --> Dev Documentation DOI

Airpeak

A Python package for recognizing build-up and decay events from pollutant concentration data and estimating pollutant loss rates.

Installation

You can simply install this python package by running this in your terminal

bash pip install airpeak

or

  1. Clone this repository on your machine : bash git clone git@github.com:EPFL-HOBEL/Airpeak.git

  2. Go inside the root directory of this package (where pyproject.toml is) and run this command :

bash pip install .

Documentation

You can either read online documentation from this link.

Or follow these steps and build them locally :

  1. Go inside the root directory of this package (where pyproject.toml is) and run this command : bash pip install .[docs]

  2. Run from root directory bash make -C docs html

  3. Open docs/build/html/index.html with your favorite browser.

Reference

  1. Du, B., & Siegel, J. A. (2023). Estimating indoor pollutant loss using mass balances and unsupervised clustering to recognize decays. Environmental Science & Technology, 57(27), 10030-10038. https://doi.org/10.1021/acs.est.3c00756

  2. Du, B., Reda, I., Licina, D., Kapsis, C., Qi, D., Candanedo, J. A., & Li, T. (2024). Estimating Air Change Rate in Mechanically Ventilated Classrooms Using a Single CO2 Sensor and Automated Data Segmentation. Environmental science & technology, 58(42), 18788-18799. https://doi.org/10.1021/acs.est.4c02797

Contributors ✨

Thanks goes to these wonderful people (emoji key):

Bowen Du
Bowen Du
💻 🔣		 Quentin Eschmann
Quentin Eschmann
💻 📖

This project follows the all-contributors specification. Contributions of any kind welcome!

Owner

  • Name: EPFL-HOBEL
  • Login: EPFL-HOBEL
  • Kind: organization
  • Location: Switzerland

Human-Oriented Built Environment Lab (HOBEL) at EPFL

Citation (CITATION.cff) 

cff-version: 1.2.0
message: "If you use this software, please cite it as below."
authors:
- family-names: "Du"
  given-names: "Bowen"
  orcid: "https://orcid.org/0000-0001-5561-4390"
- family-names: "Siegel"
  given-names: "Jeffrey A."
  orcid: "https://orcid.org/0000-0001-5904-169X"
title: "Airpeak: A Python package for recognizing build-up and decay events from pollutant concentration data and estimating pollutant loss rates."
version: 1.0.0
doi: 10.5281/zenodo.15745122
date-released: 2025-06-26
url: "https://github.com/EPFL-HOBEL/Airpeak"
references:
  - type: article
    authors:
      - family-names: "Du"
        given-names: "Bowen"
      - family-names: "Siegel"
        given-names: "Jeffrey A."
    title: "Estimating Indoor Pollutant Loss Using Mass Balances and Unsupervised Clustering to Recognize Decays"
    journal: "Environmental Science & Technology"
    year: 2023
    volume: 57
    issue: 27
    start: 10030
    end: 10038
    doi: "10.1021/acs.est.3c00756"
  - type: article
    authors:
      - family-names: "Du"
        given-names: "Bowen"
      - family-names: "Reda"
        given-names: "Ibrahim"
      - family-names: "Licinda"
        given-names: "Dusan"
      - family-names: "Kapsis"
        given-names: "Costa"
      - family-names: "Qi"
        given-names: "Dahai"
      - family-names: "Candanedo"
        given-names: "José A."
      - family-names: "Li"
        given-names: "Tianyuan"
    title: "Estimating Air Change Rate in Mechanically Ventilated Classrooms Using a Single CO2 Sensor and Automated Data Segmentation"
    journal: "Environmental Science & Technology"
    year: 2024
    volume: 58
    issue: 42
    start: 18788
    end: 18799
    doi: "10.1021/acs.est.4c02797"

GitHub Events

Total
  • Create event: 4
  • Release event: 4
  • Issues event: 3
  • Watch event: 2
  • Member event: 1
  • Issue comment event: 4
  • Public event: 1
  • Push event: 36
  • Pull request review event: 3
  • Pull request review comment event: 1
  • Pull request event: 9
Last Year
  • Create event: 4
  • Release event: 4
  • Issues event: 3
  • Watch event: 2
  • Member event: 1
  • Issue comment event: 4
  • Public event: 1
  • Push event: 36
  • Pull request review event: 3
  • Pull request review comment event: 1
  • Pull request event: 9