Open and Affordable Quantitative Imaging Platform https://www.planktoscope.org
Find a file
Romain Bazile f5763b48c0
Update the documentation for Read The Docs (#43)
Closes #47 .

* Update to documentation to use RTD with mkdocs locally

Initial setup for Read The Doc using mkdocs to build the documentation.
Most of the doc still needs to be rewritten (Expert Setup is the only
part using MD for now).

* README: remove the repo clone step

* Update to documentation to use RTD with mkdocs locally

Initial setup for Read The Doc using mkdocs to build the documentation.
Most of the doc still needs to be rewritten (Expert Setup is the only
part using MD for now).

* documentation edition guide

* Expert setup changes and main README changes

* software architecture stub

* basic doc structure in place

* mqtt message documentatin

* software architecture

* more images

* First README rewrite

* Add admonition configuration

* Various small updates

* how to get involved

* License! Martyr proposal

* Scripts README

* Assembly guide stub

* mkdocs: add assembly guide

* assembly guide: halfway there

* readme: transition to webp for lighter pictures

* README: add extension to path

* README: add assembly guide link

* assembly: complete guide

* add readthedocs config file

* add docs requirements.txt for pip
2020-10-07 12:44:17 +02:00
.github Update issue templates 2020-09-17 12:03:00 +02:00
docs add docs requirements.txt for pip 2020-10-07 12:34:00 +02:00
flows License! Martyr proposal 2020-10-07 12:25:50 +02:00
hardware License! Martyr proposal 2020-10-07 12:25:50 +02:00
morphocut Rename installation.txt to README.md 2020-07-22 10:03:46 +02:00
scripts Scripts README 2020-10-07 12:25:50 +02:00
.readthedocs.yml add readthedocs config file 2020-10-07 12:30:49 +02:00
config.json Extraction and refactor of the python code from node-red flow 2020-09-28 11:05:27 +02:00
hardware.json Extraction and refactor of the python code from node-red flow 2020-09-28 11:05:27 +02:00
LICENSE License! Martyr proposal 2020-10-07 12:25:50 +02:00
mkdocs.yml mkdocs: add assembly guide 2020-10-07 12:25:50 +02:00
package.json package: update dependencies 2020-10-07 12:22:52 +02:00
README.md Features 2020-10-07 12:43:59 +02:00
requirements.txt Extraction and refactor of the python code from node-red flow 2020-09-28 11:05:27 +02:00

An open and affordable imaging platform for citizen oceanography

PlanktoScope Render

Plankton collage

What is this?

The PlanktoScope is an open-source, affordable imaging platform for citizen oceanography. It's built around a Raspberry Pi, a couple of HATs, some stepper motors and a few centimeters of silicon tubes. Its cost is at about $500 in parts.

The goal of the PlanktoScope is to allow citizen to engage in scientific programs, either at sea or onshore. You can use the PlanktoScope to image the different species of Plankton living in a body of water.

Get the papers!

The PlanktoScope has been described in a paper available on the bioRxiv preprint server. The first results of this program and its outline are also available as a preprint.

PlanktoScope Preprint PlanktonPlanet Preprint

Key Features

  • Image small animals and algae living in water
  • Focus stage control
  • Pump control
  • Automatic image capture
  • Automatic segmentation

How do I build one?

You can access the complete documentation on Read The Docs.

How do I get involved?

There are several ways to join the development effort, share your progress with your build or just ask for help.

We are using slack as a communication platform between interested parties. You can request to join by filling this form.

This repository is also a good way to get involved. Please fill in an issue if you witnessed a bug in the software or hardware. If you are able, you can also join the development effort. Look through the issues opened and choose one that piques your interest. Let us know you want to work on it in the comments, we may even be able to guide your beginnings around the code.