Metadata-Version: 2.1
Name: wellmap
Version: 3.2.0
Summary: File format for 96-well plate layouts.
Home-page: https://github.com/kalekundert/wellmap
Author: Kale Kundert
Author-email: kale@thekunderts.net
Requires-Python: ~=3.6
Description-Content-Type: text/x-rst
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3.6
Classifier: Topic :: Scientific/Engineering :: Bio-Informatics
Requires-Dist: pandas
Requires-Dist: toml>=0.10
Requires-Dist: inform>=1.15
Requires-Dist: docopt
Requires-Dist: matplotlib
Requires-Dist: colorcet
Requires-Dist: sphinxcontrib-programoutput ; extra == "docs"
Requires-Dist: sphinx_rtd_theme ; extra == "docs"
Requires-Dist: myst-parser ; extra == "docs"
Requires-Dist: pytest ; extra == "tests"
Requires-Dist: pytest-cov ; extra == "tests"
Requires-Dist: pytest-unordered ; extra == "tests"
Requires-Dist: pytest-subtests ; extra == "tests"
Requires-Dist: parametrize_from_file ; extra == "tests"
Requires-Dist: hypothesis ; extra == "tests"
Requires-Dist: coveralls ; extra == "tests"
Requires-Dist: attrs ; extra == "tests"
Project-URL: Bug Tracker, https://github.com/kalekundert/wellmap/issues
Project-URL: Continuous Integration, https://travis-ci.org/kalekundert/wellmap
Project-URL: Documentation, https://wellmap.readthedocs.io/en/latest/
Project-URL: Test Coverage, https://coveralls.io/github/kalekundert/wellmap
Project-URL: Version Control, https://github.com/kalekundert/wellmap
Provides-Extra: docs
Provides-Extra: tests

***************************************************
``wellmap`` — File format for 96-well plate layouts
***************************************************

.. image:: https://img.shields.io/pypi/v/wellmap.svg
   :target: https://pypi.python.org/pypi/wellmap

.. image:: https://img.shields.io/pypi/pyversions/wellmap.svg
   :target: https://pypi.python.org/pypi/wellmap

.. image:: https://img.shields.io/badge/R-3.0,4.0-blue.svg
   :target: http://wellmap.readthedocs.io/en/latest/basic_usage_with_r.html

.. image:: https://readthedocs.org/projects/wellmap/badge/?version=latest
   :target: http://wellmap.readthedocs.io/en/latest/

.. image:: https://img.shields.io/github/workflow/status/kalekundert/wellmap/Test%20and%20release/master
   :target: https://github.com/kalekundert/wellmap/actions

.. image:: https://img.shields.io/coveralls/kalekundert/wellmap.svg
   :target: https://coveralls.io/github/kalekundert/wellmap?branch=master

Many medium-throughput experiments produce data in 24-, 96-, or 384-well plate 
format.  However, it can be a challenge to keep track of which wells (e.g. A1, 
B2, etc.) correspond to which experimental conditions (e.g. genotype, drug 
concentration, replicate number, etc.) for large numbers of experiments.  It 
can also be a challenge to write analysis scripts flexible enough to handle the 
different plate layouts that will inevitably come up as more and more 
experiments are run.

The *wellmap* package solves these challenges by introducing a `TOML-based file 
format`__ that succinctly describes the organization of wells on plates.  The 
file format is designed to be human-readable and -writable, so it can serve as 
a standalone digital record.  The file format can also be easily parsed in 
python and R to help write analysis scripts that will work regardless of how 
you (or your collaborators) organize wells on your plates.

__ https://wellmap.readthedocs.io/en/latest/file_format.html

Citation
========
Kundert, K. Wellmap: a file format for microplate layouts. *BMC Res Notes* 
**14**, 164 (2021). https://doi.org/10.1186/s13104-021-05573-0

Documentation
=============
See the complete documentation `here <http://wellmap.readthedocs.io/>`_.

.. image:: docs/manuscript/figures/well_groups.svg

