.. scikit-ferm documentation master file, created by
sphinx-quickstart on Mon Jan 20 09:41:04 2025.
You can adapt this file completely to your liking, but it should at least
contain the root `toctree` directive.
scikit-ferm documentation
=========================================
**scikit-ferm** is a Python package designed to be a toolkit, when working with fermentation data. Whether you're studying food fermentation (like yogurt production) or simulating microbial behavior for research and development, scikit-ferm provides flexible tools to simulate, process and learn.
Based on the `scikit-learn `_ API and `pandas `_ API, scikit-ferm is designed to be easy to use and integrate with other Python packages. It's also built with extensibility in mind, so you can easily add new models and datasets to suit your needs.
.. note::
This project is under active development.
Check out the sections below to get started with scikit-ferm:
.. grid:: 1 2 3 3
:gutter: 2
.. grid-item-card:: 📚 Usage Guide
:link: usage
:link-type: doc
:class-header: text-center
:class-card: intro-card text-center
Learn how to install and use scikit-ferm with examples and tutorials.
.. grid-item-card:: 🔧 API Reference
:link: skferm
:link-type: doc
:class-header: text-center
:class-card: intro-card text-center
Complete reference for all classes, functions, and modules in scikit-ferm.
.. grid-item-card:: 📖 Index
:link: genindex
:link-type: ref
:class-header: text-center
:class-card: intro-card text-center
Search through all functions, classes, and terms in the documentation.
.. toctree::
:hidden:
:maxdepth: 2
usage
.. toctree::
:hidden:
:maxdepth: 1
skferm