Commit b88c5dfd authored by Marion  LOUVEAUX's avatar Marion LOUVEAUX
Browse files

Update README new-readme complete

parent cd7da198
# Well Plate Reader - Read well plates on Icy
# wellPlateReader
## Description
<!-- badges: start -->
[![License: GPL v3](](
[![ forum](](
<!-- badges: end -->
This is the repository for the source code of *wellPlateReader*, a plugin for the [bioimage analysis software Icy](, which was developed by members or former members of the [Biological Image Analysis unit at Institut Pasteur]( This plugin is licensed under GPL3 license.
Icy is developed and maintained by [Biological Image Analysis unit at Institut Pasteur]( The [source code of Icy]( is also licensed under a GPL3 license.
## Plugin description
<!-- Short description of goals of package, with descriptive links to the documentation website -->
Well plate support for Icy, with an interactive well plate viewer and batch processing capabilities within Protocols
A more detailed user documentation can be found on the wellPlateReader documentation page on the Icy website:
## Installation instructions
For end-users, refer to the documentation on the Icy website on [how to install an Icy plugin](
For developers, see our [Contributing guidelines]( and [Code of Conduct](
<!-- Here we should have some explanations on how to fork this repo (for an example see Add any info related to Maven etc. How the project is build (for an example see Any additional setup required (authentication tokens, etc). -->
## Main functions and usage
<!-- list main functions, explain architecture, classname, give info on how to get started with the plugin. If applicable, how the package compares to other similar packages and/or how it relates to other packages -->
Classname: `plugins.adufour.hcs.WellPlateImporter`
## Citation
Please cite this plugins as follows:
Please also cite the Icy software and mention the version of Icy you used (bottom right corner of the GUI or first lines of the Output tab):
de Chaumont, F. et al. (2012) Icy: an open bioimage informatics platform for extended reproducible research, [Nature Methods](, 9, pp. 690-696
## Author(s)
Alexandre Dufour, Vannary Meas-Yedid, Daniel Felipe González Obando
## Additional information
This project contains the code necessary to import and show well plates from Opera machines.
This project has been developed as a _Gradle_ project and can be opened with _Eclipse_ IDE.
### Available plugins
Available plugins
......@@ -15,9 +74,9 @@ In
This plugin reads the information of a well plate and then shows an interface with the available plates and their corresponding fields.
## Installation
### Requirements
In order to be able to work with this project you must have installed the following software:
......@@ -28,7 +87,7 @@ In order to be able to work with this project you must have installed the follow
- **Eclipse**, version _Neon_ or above. Make sure to have the _Buildship_ plugin installed. ([Available here](
- **Icy4Eclipse** plugin for Eclipse, the latest version available. Follow [these]( instructions.
### Setup
1. Use your *Git* repository manager of preference to download this repository (you can use Eclipse Git perspective to do this). The repository URL is [](
2. Make sure the environment variable **ICY_HOME** is set to the location of your Icy installation. _**Note**: This could be tricky on Mac so make sure to follow [these]( instructions._
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment