Skip to main content

GitHub License All Contributors 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.

pip install Airpeak

or

  1. Clone this repository on your machine :

    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 :

    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 :

    pip install .[docs]
    
  2. Run from root directory

    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!

Metadata

Release files for airpeak 1.0.5

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for airpeak 1.0.5
File Size Uploaded Provenance Actions
airpeak-1.0.5.tar.gz 21.9 kB Without provenance Details for airpeak-1.0.5.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for airpeak 1.0.5
File Interpreter ABI Platform Actions
airpeak-1.0.5-py3-none-any.whl Python 3 none any Details for airpeak-1.0.5-py3-none-any.whl

Total release size: 46.8 kB

Release files / airpeak-1.0.5.tar.gz

Download URL airpeak-1.0.5.tar.gz
Size 21.9 kB
Tags Source
SHA-256 checksum
How to use checksums
9b457aa64b3fef1b7af50bfa127a6a8ed37d45ba93f3052ab39cf6c7b23b09fe
BLAKE2b-256 checksum
How to use checksums
480983c43d2c9278117a19ff44de74a48bc4e7af17663735afdb488644d73d4b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Release files / airpeak-1.0.5-py3-none-any.whl

Download URL airpeak-1.0.5-py3-none-any.whl
Size 24.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4becd9e5593804bf1b08300abc0699276fdbf324458ffafaae9647b3d25507ef
BLAKE2b-256 checksum
How to use checksums
0f731819960c363a85745ab020c4f13b406faba7aeaebdac8555e3d5467378b3
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.7

Security for airpeak 1.0.5

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page