asm1-influent-generator

v0.0.6

A Python Module to generate Arrays in the Activated Sludge Model 1 (ASM1) format. For more information about how to use this package see README

Latest version published 7 months ago

License: BSD-3-Clause

PyPI

GitHub

Package Health Score

65 / 100

security
No known security issues
popularity
Small
maintenance
Inactive
community
Sustainable

Popularity

Small

GitHub Stars: 602
Forks: 88
Contributors: 30

Direct Usage Popularity

Based on project statistics from the GitHub repository for the PyPI package asm1-influent-generator, we found that it has been starred 602 times.

Security

No known security issues

Security and license risk for latest version

Release Date: May 12, 2024
Direct Vulnerabilities: 0
C
0
H
0
M
0
L
Indirect Vulnerabilities: 0
C
0
H
0
M
0
L
License Risk: 0
H
0
M
0
L

All security vulnerabilities belong to production dependencies of direct and indirect packages.

License

BSD-3-Clause

Security Policy

We found a way for you to contribute to the project! Looks like asm1-influent-generator is missing a security policy.

You can connect your project's repository to Snyk to stay up to date on security alerts and receive automatic fix pull requests.

Keep your project free of vulnerabilities with Snyk

Maintenance

Inactive

Commit Frequency

Open Issues: 0
Open PR: 0
Last Release: 7 months ago
Last Commit: 13 days ago

Further analysis of the maintenance status of asm1-influent-generator based on released PyPI versions cadence, the repository activity, and other data points determined that its maintenance is Inactive.

We found that asm1-influent-generator demonstrates a positive version release cadence with at least one new version released in the past 12 months.

In the past month we didn't find any pull request activity or change in issues status has been detected for the GitHub repository.

Community

Sustainable

Readme: Yes
Contributing.md: No
Code of Conduct: Yes
Contributors: 30
Funding: No

With more than 10 contributors for the asm1-influent-generator repository, this is possibly a sign for a growing and inviting community.

Embed Package Health Score Badge

Keep your project healthy

Check your requirements.txt

Ensure all the packages you're using are healthy and well-maintained

Snyk Vulnerability Scanner

Get health score & security insights directly in your IDE

Package

Python Versions Compatibility: >=3.9

Age: 8 months
Latest Release: 7 months ago
Dependencies: 4 Direct
Versions: 4
Maintainers: 0
Wheels: OS Independent

Readme

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.

asm1-influent-generator dependencies

gretel-synthetics numpy torch typer

FAQs

What is asm1-influent-generator?

A Python Module to generate Arrays in the Activated Sludge Model 1 (ASM1) format. Visit Snyk Advisor to see a full health score report for asm1-influent-generator, including popularity, security, maintenance & community analysis.

Is asm1-influent-generator popular?

We’re still processing downloads data for the python package asm1-influent-generator. Visit the popularity section on Snyk Advisor to see the full popularity analysis.

Is asm1-influent-generator well maintained?

We found indications that asm1-influent-generator is an Inactive project. See the full package health analysis to learn more about the package maintenance status.

Is asm1-influent-generator safe to use?

The python package asm1-influent-generator was scanned for known vulnerabilities and missing license, and no issues were found. Thus the package was deemed as safe to use. See the full health analysis review.

Last updated on 20 December-2024, at 16:32 (UTC).

Build a secure application checklist

Select a recommended open source package

Minimize your risk by selecting secure & well maintained open source packages

DONE

Scan your app for vulnerabilities

Scan your application to find vulnerabilities in your: source code, open source dependencies, containers and configuration files

SCAN NOW

Fix identified vulnerabilities

Easily fix your code by leveraging automatically generated PRs

AUTO FIX

Monitor for new issues

New vulnerabilities are discovered every day. Get notified if your application is affected

MONITOR APP