Skip to content

Commit

Permalink
PyPI readme
Browse files Browse the repository at this point in the history
  • Loading branch information
veghp committed Sep 29, 2020
1 parent 717d334 commit c9a6086
Show file tree
Hide file tree
Showing 2 changed files with 50 additions and 1 deletion.
49 changes: 49 additions & 0 deletions pypi-readme.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,49 @@
Plateo
======

Plateo (pronounced *Plato*, like the planet) is a Python library to assist in the
planning, running and checking of laboratory experiments involving microplates.

It can be used to:

- Read and write robotic protocols (picklists) in different formats to
accomodate different liquid dispensers (Tecan EVO, Labcyte Echo).
- Simulate liquid dispensing runs, taking into account the capacity and dead
volume of each container, to predict the maps of future plates.
- Parse plate data from common laboratory robots (for kinetic experiments,
fragment analysis, qPCR, etc.)
- Export plate information in various formats (graphics, spreadsheets, HTML,
JSON, etc.).


Infos
-----

**PIP installation:**

.. code:: bash
pip install plateo
**Web documentation:**

`<https://edinburgh-genome-foundry.github.io/Plateo/>`_

**Github Page:**

`<https://github.com/Edinburgh-Genome-Foundry/Plateo>`_

**Live demo:**

`<https://cuba.genomefoundry.org/create_assembly_picklists>`_

**License:** MIT, Copyright Edinburgh Genome Foundry


More biology software
---------------------

.. image:: https://raw.githubusercontent.com/Edinburgh-Genome-Foundry/Edinburgh-Genome-Foundry.github.io/master/static/imgs/logos/egf-codon-horizontal.png
:target: https://edinburgh-genome-foundry.github.io/

Plateo is part of the `EGF Codons <https://edinburgh-genome-foundry.github.io/>`_ synthetic biology software suite for DNA design, manufacturing and validation.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
version=__version__,
author="Zulko",
description="Read/write microplate and picklist data for lab automation",
long_description=open("README.rst").read(),
long_description=open("pypi-readme.rst").read(),
license="MIT",
keywords="microplate biology parser converter report",
packages=find_packages(exclude="docs"),
Expand Down

0 comments on commit c9a6086

Please sign in to comment.