Skip to main content

ASM1 Influent Generator

A Python Module to generate influent data in the Activated Sludge Model 1 (ASM1) format. This module creates arrays in the format required by the ASM1 model, which is used to simulate the biological processes in wastewater treatment plants. The resulting arrays are resolving to 15 minute time steps and can be used as influent data for the simulation of wastewater treatment plants.

Getting started

Installation

Simply install the package with pip:

pip install asm1-influent-generator

Usage

Command Line

There are different ways to use the module. The easiest way is to just call it from the command line:

asm1-influent-generator 1

This will generate one array with 50 days of influent data. The resulting array will be saved as a CSV file in the current working directory.

Python

You can also use the module in your own Python code:

from asm1_influent_generator import ASM1Generator

gen = ASM1Generator()
arr = gen.generate(5)

This example will generate one array with 5 samples of 50 days of influent data. The resulting numpy array has the shape (n_samples, n_timesteps, n_components).

Limitations

The module is currently limited to a 50 day generation period. Also, the time step is fixed to 15 minutes. This is due to the fact, that the underlying Generative Adversarial Network (GAN) was trained on 50 days of 15 minute time steps.

The Model

We use gretel-synthetics to generate synthetic data. The model is a DoppelGANger model. It was trained on data from the IWA Benchmark Simulation Model No. 2 (BSM2) influent dataset which originally features 609 days of influent data. It was trained for 200.000 epochs.

Credits

The development of this package was done in the context of the KLÄFFIZIENT project. The project is funded by the German Federal Ministry for Economic Affairs and Climate Action (BMWK) and is part of the 7th Energy Research Program of the Federal Government.

Metadata

Release files for asm1-influent-generator 0.0.6

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

Source distribution (sdist)

Source distribution for asm1-influent-generator 0.0.6
File Size Uploaded
asm1_influent_generator-0.0.6.tar.gz 43.5 MB Details

Built distribution (wheel)

Table of built distributions (wheels) for asm1-influent-generator 0.0.6
File Interpreter ABI Platform
asm1_influent_generator-0.0.6-py3-none-any.whl Python 3 none any Details

Total release size: 87.0 MB

Release files / asm1_influent_generator-0.0.6.tar.gz

Download URL asm1_influent_generator-0.0.6.tar.gz
Size 43.5 MB
Tags Source
SHA-256 checksum
How to use checksums
19501394f87b81bb8e72dad866e6c7a73974791303b2c6a4099036ee0b37f9dc
BLAKE2b-256 checksum
How to use checksums
f253afbb7bde66286fa89485492b6e0a63a43ac18b9149f4a854276f6710b806
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-httpx/0.27.0

Release files / asm1_influent_generator-0.0.6-py3-none-any.whl

Download URL asm1_influent_generator-0.0.6-py3-none-any.whl
Size 43.5 MB
Tags Python 3
SHA-256 checksum
How to use checksums
b57c5e3c6f405f3d382ba878ff928c04f98bc0d20c52f62a39146b3235cb4d30
BLAKE2b-256 checksum
How to use checksums
98168fffd0b39b62abd8bb5b5e2e884d42fde853a7c2eb8a853dd58116e647e2
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via python-httpx/0.27.0

Release history Release notifications | RSS feed

This release

0.0.6 This release

2 release files

0.0.5

2 release files

0.0.4

2 release files

0.0.1

2 release files

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