Skip to main content

A scikit-learn compatible package for fermentations.

Project description

sphinx tests type_checks release

Version

scikit-ferm

scikit-ferm is a Python package designed to generate synthetic fermentation datasets and model microbial growth dynamics. Whether you're studying food fermentation (like yogurt production) or simulating microbial behavior for research and development, scikit-ferm provides flexible tools to create realistic datasets based on established growth models.

The official documentation is hosted here.

Installation

Install scikit-ferm via pip with:

uv pip install scikit-ferm

Alternatively, to edit and contribute you can fork/clone and run:

git clone https://github.com/Aschwins/scikit-ferm.git
uv sync

Use cases

Use Case Modules Notebook Documentation
Generate synthetic fermentation datasets skferm.datasets.generate_synthetic_growth
skferm.datasets.rheolaser
📓 Notebook 📚 Docs
Growth modeling skferm.growth_models.gompertz
skferm.growth_models.logistic
📓 Notebook 📚 Docs
Curve smoothing skferm.curve_smoothing.smooth 📓 Notebook 📚 Docs

Examples

Jupyter notebooks are used to demonstrate examples. You can find the notebooks in the notebooks directory. Each example describes a use case. To run the examples you need to install scikit-ferm with an additional dependencies and start Jupyter Lab.

uv sync
jupyter lab

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

scikit_ferm-0.1.2.tar.gz (421.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

scikit_ferm-0.1.2-py3-none-any.whl (424.6 kB view details)

Uploaded Python 3

File details

Details for the file scikit_ferm-0.1.2.tar.gz.

File metadata

  • Download URL: scikit_ferm-0.1.2.tar.gz
  • Upload date:
  • Size: 421.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.8.23

File hashes

Hashes for scikit_ferm-0.1.2.tar.gz
Algorithm Hash digest
SHA256 fdaf5805415f21974a32249999a4634f0a7054034bc0c1a6da377acb112651e5
MD5 82b874aba1ebc58b99e6e6e6740acae7
BLAKE2b-256 e0fa7b62fdbe6d1d37fe5053c56a7a399a21d1b62cab95cb2e48abf4f078a757

See more details on using hashes here.

File details

Details for the file scikit_ferm-0.1.2-py3-none-any.whl.

File metadata

File hashes

Hashes for scikit_ferm-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 702cd8111455cd54f56155cc3e2ba127a99f0cccbe478b38b9e257f418d165c1
MD5 e13b9440c363109ccae3b7484a2306d7
BLAKE2b-256 93a42b66c5c9cb7f97f5cb211d32c612e1157eb24ebde8b73be06ebbcbb5800b

See more details on using hashes here.

Supported by

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