Metadata-Version: 2.3
Name: cv2_group
Version: 0.3.0
Summary: A versatile toolkit to analyze roots within petri dishes.
License: MIT
Author: Yorbe Heeren
Author-email: 232922@buas.nl
Requires-Python: ==3.10.11
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Requires-Dist: azureml-core
Requires-Dist: azureml-dataprep[fuse,pandas]
Requires-Dist: azureml-defaults (>=1.55.0,<1.56.0)
Requires-Dist: azureml-mlflow (>=1.55.0,<1.56.0)
Requires-Dist: azureml-train (>=1.55.0,<1.56.0)
Requires-Dist: azureml-train-core (>=1.55.0,<1.56.0)
Requires-Dist: click (==8.1.3)
Requires-Dist: docker (==7.1.0)
Requires-Dist: fastapi (==0.110.0)
Requires-Dist: fusepy
Requires-Dist: ghp-import (==2.1.0)
Requires-Dist: matplotlib (==3.8.4)
Requires-Dist: numpy (==1.23.5)
Requires-Dist: opencv-python (==4.10.0.84)
Requires-Dist: patchify (==0.2.3)
Requires-Dist: pillow (==10.3.0)
Requires-Dist: protobuf (>=3.9.2,<3.20)
Requires-Dist: pytest (==8.3.0)
Requires-Dist: pytest-cov (==6.1.1)
Requires-Dist: scikit-image (==0.22.0)
Requires-Dist: scikit-learn (>=1.6.1,<2.0.0)
Requires-Dist: streamlit (==1.22.0)
Requires-Dist: tensorflow (==2.10.0)
Requires-Dist: tensorflow-io-gcs-filesystem (==0.26.0)
Requires-Dist: typer (==0.9.0)
Requires-Dist: uvicorn (==0.29.0)
Requires-Dist: wandb (==0.16.6)
Description-Content-Type: text/markdown

<picture align="center">
  <source media="(prefers-color-scheme: dark)" srcset="docs/assets/cv2_group_logo_dark.png">
  <img alt="cv2_group logo" src="docs/assets/cv2_group_logo_light.png">
</picture>

---

# cv2_group: Python toolkit for analyzing plant roots

| Category | Badges |
|----------|--------|
| Testing  | [![Test Suite](https://github.com/BredaUniversityADSAI/2024-25d-fai2-adsai-group-cv-2/actions/workflows/test.yml/badge.svg?branch=main&event=push)](https://github.com/BredaUniversityADSAI/2024-25d-fai2-adsai-group-cv-2/actions/workflows/test.yml) [![codecov](https://codecov.io/github/BredaUniversityADSAI/2024-25d-fai2-adsai-group-cv-2/graph/badge.svg?token=8RX0P5R3V5)](https://codecov.io/github/BredaUniversityADSAI/2024-25d-fai2-adsai-group-cv-2) |
| Package  | [![PyPI Version](https://img.shields.io/pypi/v/cv2_group.svg)](https://pypi.org/project/cv2_group/) [![PyPI Downloads](https://img.shields.io/pypi/dm/cv2_group.svg)](https://pypi.org/project/cv2_group/) |
| License  | [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](./LICENSE) |


## About

**cv2_group** is a Python package that provides tools for processing images of petri dishes containing plants. (EXPAND ON THIS LATER)

## Table of Contents

This table of contents is just an example, we can add or remove later.

- [Main Features](#main-features)
- [Where to get it](#where-to-get-it)
- [Dependencies](#dependencies)
- [License](#license)
- [Documentation](#documentation)
- [Background](#background)

## Main Features

The ``cv2_group`` package allows you to analyze roots within a petri dish, here are some of the most useful features:

- Cropping images based on the petri dish.
- EXPAND

## Where to get it

The latest release of cv2_group is available on [PyPI](https://pypi.org/project/cv2_group/):

```pip install cv2_group```

## Dependencies

The package requires the following core dependencies:

- ```numpy```
- ```opencv-python```
- ```scikit-image```
- ```patchify```
- ```tensorflow```
- ```matplotlib```
- ```pillow```

These will be installed automatically when you install the package via ```pip```.

## License

[MIT](LICENSE)

## Documentation

The official documentation is hosted on [Github Pages](https://bredauniversityadsai.github.io/2024-25d-fai2-adsai-group-cv-2/data/index.html)

## Background

Work on ``cv2_group`` started at Breda University of Applied Sciences [BUas](https://www.buas.nl/) in 2025 and has been under development since then.

---

[Go to Top](#table-of-contents)
