Skip to main content

Library with routines for data-driven process monitoring.

Project description

Binder Apache 2.0 CC BY 4.0

BibMon

BibMon (from the Portuguese Biblioteca de Monitoramento de Processos, or Process Monitoring Library) is a Python package that provides deviation-based predictive models for fault detection, soft sensing, and process condition monitoring.

For further information, please refer to the documentation or to the scientific publication detailing BibMon.

Installation

BibMon can be installed using pip:

pip install bibmon

Or conda:

conda install conda-forge::bibmon

Available Models

  • PCA (Principal Component Analysis);
  • ESN (Echo State Network);
  • SBM (Similarity-Based Method);
  • Autoencoders;
  • any regressor that uses the scikit-learn interface.

Usage

Essentially, the library is used in two steps:

  1. In the training step, a model is generated that captures the relationships between variables in the normal process condition;
  2. In the prediction step, process data is compared to the model's predictions, resulting in deviations; if these deviations exceed a predefined limit, alarms are triggered.

Specifically, the implemented control charts are based on squared prediction error (SPE).

For more details, please refer to the tutorials available in the documentation to learn about the main functionalities of BibMon. You can find the corresponding Jupyter Notebooks for these tutorials in the docs/source/ directory.

Features

The resources offered by BibMon are:

  • Application in online systems: a trained BibMon model can be used for online analysis with both individual samples and data windows. For each sample or window, a prediction is made, the model state is updated, and alarms are calculated.
  • Compatibility, within the same architecture, of regression models (i.e., virtual sensors, containing separate X and Y data, such as RandomForest) and reconstruction models (containing only X data, such as PCA).
  • Preprocessing pipelines that take into account the differences between X and Y data and between training and testing stages.
  • Possibility of programming different alarm logics.
  • Easy extensibility through inheritance (there is a class called GenericModel that implements all the common functionality for various models and can be used as a base for implementing new models). For details, consult the CONTRIBUTING.md file.
  • Convenience functions for performing automatic offline analysis and plotting control charts.
  • Real and simulated process datasets available for importing.
  • Comparative tables to automate the performance analysis of different models.
  • Automatic hyperparameter tuning.

Contributing

BibMon is an open-source project driven by the community. If you would like to contribute to the project, please refer to the CONTRIBUTING.md file.

The package originated from research projects conducted in collaboration between the Chemical Engineering Program at COPPE/UFRJ and the Leopoldo Américo Miguez de Mello Research Center (CENPES/Petrobras).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

bibmon-1.1.6.tar.gz (4.9 MB view details)

Uploaded Source

Built Distribution

bibmon-1.1.6-py3-none-any.whl (5.3 MB view details)

Uploaded Python 3

File details

Details for the file bibmon-1.1.6.tar.gz.

File metadata

  • Download URL: bibmon-1.1.6.tar.gz
  • Upload date:
  • Size: 4.9 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for bibmon-1.1.6.tar.gz
Algorithm Hash digest
SHA256 97e70bd3f796945a17d7e404b3b91070b9aaa51ccdd5004b10507a7a156bf41c
MD5 c055f79e7fdfc1714687f81284822120
BLAKE2b-256 21a3449c89b9b2e9874143a0f4fb1fdf2ba7424ee42fdfc731c9576ef62ebc03

See more details on using hashes here.

File details

Details for the file bibmon-1.1.6-py3-none-any.whl.

File metadata

  • Download URL: bibmon-1.1.6-py3-none-any.whl
  • Upload date:
  • Size: 5.3 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.1.1 CPython/3.9.20

File hashes

Hashes for bibmon-1.1.6-py3-none-any.whl
Algorithm Hash digest
SHA256 2e8f83c34df6f34640557467fa051c23a7309acca70f8b0d3786af85babb7f41
MD5 9e9a7c80d2babcc26ec9fb0f028c314b
BLAKE2b-256 e9a26c0130221887c641dd59e49f47e74f741a59410b688c6253b14106653876

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page