Metadata-Version: 2.3
Name: microscopemetrics
Version: 0.0.4
Summary: A package providing analysis routines to measure the performance of microscopes used in biomedical research
License: GPL-3.0-only
Keywords: microscopy,metrology
Author: Julio Mateos Langerak
Author-email: julio.mateos-langerak@igh,cnrs.fr
Maintainer: Julio Mateos Langerak
Maintainer-email: julio.mateos-langerak@igh,cnrs.fr
Requires-Python: >=3.9.18,<3.12
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Topic :: Scientific/Engineering :: Image Processing
Requires-Dist: microscopemetrics-schema (==0.0.4)
Requires-Dist: numpy (>=2,<3)
Requires-Dist: pandas (>=2,<3)
Requires-Dist: scikit-image (>=0,<1)
Requires-Dist: scipy (>=1,<2)
Project-URL: Documentation, https://github.com/MontpellierRessourcesImagerie/microscope-metrics/tree/master/docs
Project-URL: Homepage, https://github.com/MontpellierRessourcesImagerie/microscope-metrics
Project-URL: Repository, https://github.com/MontpellierRessourcesImagerie/microscope-metrics
Description-Content-Type: text/markdown

![PyPI - Version](https://img.shields.io/pypi/v/microscopemetrics)
![PyPI - Python Version](https://img.shields.io/pypi/pyversions/microscopemetrics)
![GitHub Workflow Status (with event)](https://img.shields.io/github/actions/workflow/status/MontpellierRessourcesImagerie/microscope-metrics/run_tests_push.yml)
[![GPLv2 License](https://img.shields.io/badge/License-GPL%20v3-yellow.svg)](https://opensource.org/licenses/)

<img alt="Logo" height="150" src="https://raw.githubusercontent.com/MontpellierRessourcesImagerie/microscope-metrics/main/docs/media/microscopemetrics_logo.png" width="150"/>


# microscope-metrics

_microscope-metrics_ is a Python library to control microscope quality based on standardized samples


## Documentation

You may find documentation the [Documentation](https://github.com/juliomateoslangerak/microscope-metrics/blob/42ff5cba4d4e46310a40f67f3501e43b55eb64d9/docs) pages.

We aim to provide some example code in the future
[examples](https://github.com/juliomateoslangerak/microscope-metrics/blob/d27005964d38c461839ff705652c18358a45f784/docs/examples)
For the time being please refer to the [tests](https://github.com/juliomateoslangerak/microscope-metrics/blob/b2d101745568af294f0b40393aa9ab1fafb3d480/tests)
directory to find some example code

## Related to

microscope-metrics is designed to be used with [microscopemetrics-omero](https://github.com/MontpellierRessourcesImagerie/microscopemetrics-omero.git)
to store the results in an OMERO server.
The measurements made by micrsocope-metrics are backed up by a model that can be found in the 
[microscopemetrics-schema](https://github.com/MontpellierRessourcesImagerie/microscopemetrics-schema.git) repository. The model is also accessible through the 
[schema website](https://montpellierressourcesimagerie.github.io/microscopemetrics-schema/)

## Installation

If you just want to use microscope-metrics you may just install microscope-metrics with pip

```bash
  pip install microscopemetrics
```

For development, we use [poetry](https://python-poetry.org/)
After [installing poetry](https://python-poetry.org/docs/#installation), you can install microscope-metrics running the following command 
in the root directory of the project

```bash
  poetry install
```

## Usage/Examples

```python
# TODO: add some examples
```

## Running Tests

To run tests, use pytest from the root directory of the project

```bash
  pytest 
```


