Metadata-Version: 2.1
Name: plate-layout
Version: 1.3.0
Summary: A tool to create and visualize sample layouts for multiwell plates.
Project-URL: Source, https://github.com/ssi-dk/CD-MRG-plate_layout
Author-email: "Filip (Persson) Ljung" <filip.persson@gmail.com>
License-Expression: MIT
License-File: LICENSE.txt
Classifier: Development Status :: 4 - Beta
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: Implementation :: CPython
Classifier: Programming Language :: Python :: Implementation :: PyPy
Requires-Python: >=3.9
Requires-Dist: matplotlib
Requires-Dist: numpy
Requires-Dist: openpyxl
Requires-Dist: pandas
Requires-Dist: tomli
Description-Content-Type: text/markdown

# plate_layout

[![PyPI - Version](https://img.shields.io/pypi/v/plate-layout.svg)](https://pypi.org/project/plate-layout)
[![PyPI - Python Version](https://img.shields.io/pypi/pyversions/plate-layout.svg)](https://pypi.org/project/plate-layout)

-----

**Table of Contents**

- [Installation](#installation)
- [License](#license)
- [Example](#example)

## Installation

```console
pip install plate-layout
```

## License

`plate-layout` is distributed under the terms of the [MIT](https://spdx.org/licenses/MIT.html) license.

### TODO
- Add python script and a main function for CLI usage ...

## Example

### Defining the plate type and quality control setup
The plate dimensions and (optional) quality control layouts are are defined in a toml file; see `plate_config.toml' in the config folder for an example. 


```python

import plate_layout as pl
import pandas as pd
import numpy as np
import logging

pl.logger.setLevel(logging.INFO)
```

### Create a plate layout 
Create plate design by specifying the path to a config file directly when instantiating the class, 


### Load study data and randomize order 

### Batches - distributing samples on plates


### Export batch lists to file
You can export batch lists using the `to_file` method and specify desired file format and which columns to export. 

### Plot plate layouts
