Open Sustainable Technology

A curated list of open technology projects to sustain a stable climate, energy supply, biodiversity and natural resources.

Browse accepted projects | Review proposed projects | Propose new project | Open Issues

PlanktoScope

A modular, open-source hardware and software platform that allows for high-throughput quantitative imaging of plankton samples in aquatic biology and ecology.
https://github.com/PlanktoScope/PlanktoScope

citizen citizen-science imaging microscope microscope-platform microscopy ocean oceanography plankton planktoscope raspberry-pi-4 raspberry-pi-camera science water

Last synced: about 19 hours ago
JSON representation

Repository metadata

Open and Affordable Quantitative Imaging Platform

README

        

# PlanktoScope: Open and Affordable Quantitative Imaging Platform

![planktoscope_hero](documentation/docs/images/project_description/planktoscope_hero.png)

## What are Plankton?

_"Drifting endlessly, midway between the sea of air above and the depths of the abyss below, these strange creatures and the marine inflorescence that sustains them are called 'plankton' — the wanderers"_ - **[Rachel Carson](https://de.wikipedia.org/wiki/Rachel_Carson)**

Plankton are tiny organisms that drift in the oceans and play a crucial role in the global ecosystem. They are responsible for fixing 30-50% of the world's carbon dioxide and form the foundation of the global food chain. Despite their importance, studying plankton can be challenging due to the vast area of the oceans and the limited resources of research fleets and specialized equipment. The PlanktoScope is an open-source hardware and software platform that aims to make it easier to study plankton by providing high-throughput quantitative imaging capabilities at a low cost.

## What is a PlanktoScope?

![The PlanktoScope at tfom23 Expo](documentation/docs/images/planktoscope-buildworkshops-tfom23-expo.jpg)

The PlanktoScope is a modular, open-source platform for high-throughput quantitative imaging of plankton samples. Its small size, ease of use, and low cost make it suitable for a variety of applications, including the monitoring of laboratory cultures or natural micro-plankton communities. It can be controlled from any WiFi-enabled device and can be easily reconfigured to meet the changing needs of the user.

[Learn more about how it works](https://www.planktoscope.org/how-it-works)

## Read the Paper

The PlanktoScope has been described in the article ["PlanktoScope: Affordable Modular Quantitative Imaging Platform for Citizen Oceanography"](https://www.frontiersin.org/articles/10.3389/fmars.2022.949428/full), published in Frontiers in Marine Science in July 2022.

DOI: [https://doi.org/10.3389/fmars.2022.949428](https://doi.org/10.3389/fmars.2022.949428)

## Key Features

![planktoscope_hero](documentation/docs/images/project_description/planktoscope_architecture.png)

Here are some key features of the PlanktoScope:

1. **Low cost**: The PlanktoScope is designed to be affordable, with parts costing under $1000.
2. **Modular**: The PlanktoScope is modular, meaning it can be easily reconfigured to meet the changing needs of users.
3. **Open-source**: The PlanktoScope is based on open-source hardware and software, making it accessible to a wide community of engineers, researchers, and citizens.
4. **Versatility**: The PlanktoScope is versatile, and can be used to study a variety of plankton types, including laboratory cultures and natural micro-plankton communities.
5. **High-throughput**: The PlanktoScope is capable of high-throughput quantitative imaging, allowing users to analyze large numbers of samples quickly and efficiently.
6. **WiFi-enabled**: The PlanktoScope can be controlled from any WiFi-enabled device, making it easy to use and deploy in a variety of settings.
7. **Portable**: The PlanktoScope is small and portable, making it easy to transport and use in the field.
8. **Ease of use**: The PlanktoScope is designed to be easy to use, with instructions for assembly and use available on the PlanktoScope website.

## How do I get one?

You can access the complete documentation here: https://planktoscope.github.io/PlanktoScope/
|Get the kit|Assemble your kit|Start your machine|
|--|--|--|
|![Get the kit](documentation/docs/images/readme/get_kit.png)|![Assemble your kit](documentation/docs/images/readme/assemble_kit.png)|![Start your machine](documentation/docs/images/readme/start_pscope.png)|

## Getting Involved

There are several ways you can join the development effort and contribute to this project.

### Communication Platform

We use Slack as a communication platform for interested parties. You can request to join by filling out [this form](https://docs.google.com/forms/d/e/1FAIpQLSfcod-avpzWVmWj42_hW1v2mMSHm0DAGXHxVECFig2dnKHxGQ/viewform).

### Reporting Issues

If you have identified a bug in the software or hardware, please open an issue in this repository to report it.

### Contributing to Development

You can also contribute to the development effort by working on open issues. Check out the [issues labeled as good first issues](https://github.com/PlanktoScope/PlanktoScope/labels/good%20first%20issue) and let us know in the comments if you are interested in working on one. We may be able to provide guidance as you get started with the code.

## License Information

This repository contains various types of materials that are covered by different licenses. Please read the following information carefully to determine which license applies to the materials you wish to use.

### Hardware Files

All hardware files and documentation located in the `hardware` directory are released under the [CERN-OHL-S-2.0](https://ohwr.org/cern_ohl_s_v2.txt) license.

### Software Source Code

The source code located in the `flows` and `scripts` directories is released under the [GPL-3.0](https://www.gnu.org/licenses/gpl-3.0.en.html) license.

### Other Materials

All other materials, including documentation and pictures, are released under the [Creative Commons CC-BY-SA 4.0](https://creativecommons.org/licenses/by-sa/4.0/) license.

If you wish to use any of the materials in this repository for a project that cannot be open-sourced, please contact us using Slack so we can discuss potential solutions.

We encourage you to fork this repository and publish any improvements you make. Doing so helps others and allows us to potentially integrate your changes into this repository.

## Citing PlanktoScope
If you use PlanktoScope in your research, please use the following BibTeX entry.

```
@article{Pollina2022PlanktoScope,
author={Pollina, Thibaut and Larson, Adam G. and Lombard, Fabien and Li, Hongquan and Le Guen, David and Colin, Sébastien and de Vargas, Colomban and Prakash, Manu},
title={PlanktoScope: Affordable Modular Quantitative Imaging Platform for Citizen Oceanography},
journal={Frontiers in Marine Science},
year={2022},
doi={10.3389/fmars.2022.949428}
}
```


Owner metadata


GitHub Events

Total
Last Year

Committers metadata

Last synced: 3 days ago

Total Commits: 770
Total Committers: 8
Avg Commits per committer: 96.25
Development Distribution Score (DDS): 0.622

Commits in past year: 136
Committers in past year: 3
Avg Commits per committer in past year: 45.333
Development Distribution Score (DDS) in past year: 0.316

Name Email Commits
tpollina t****a@g****m 291
Romain Bazile g****z@g****m 265
Ethan Li l****2@g****m 93
Romain Bazile r****n@b****o 76
dependabot[bot] 4****] 42
Simon-Martin Schröder s****s@i****e 1
dnberlin f****w@f****e 1
Bakhtiyorjon Rasulov 3****e 1

Committer domains:


Issue and Pull Request metadata

Last synced: 2 days ago

Total issues: 163
Total pull requests: 209
Average time to close issues: about 1 year
Average time to close pull requests: 7 days
Total issue authors: 13
Total pull request authors: 8
Average comments per issue: 2.02
Average comments per pull request: 0.82
Merged pull request: 153
Bot issues: 0
Bot pull requests: 95

Past year issues: 96
Past year pull requests: 201
Past year average time to close issues: about 2 months
Past year average time to close pull requests: 3 days
Past year issue authors: 8
Past year pull request authors: 4
Past year average comments per issue: 1.84
Past year average comments per pull request: 0.74
Past year merged pull request: 149
Past year bot issues: 0
Past year bot pull requests: 92

More stats: https://issues.ecosyste.ms/repositories/lookup?url=https://github.com/PlanktoScope/PlanktoScope

Top Issue Authors

  • ethanjli (90)
  • gromain (47)
  • pkostyrka (11)
  • fabienlombard (4)
  • LaurentPV (2)
  • tpollina (2)
  • arhyneRWU (1)
  • babo989 (1)
  • fishballcheeks (1)
  • glx314 (1)
  • hankertrix (1)
  • kevin-duclos (1)
  • Mrvy29 (1)

Top Pull Request Authors

  • ethanjli (108)
  • dependabot[bot] (92)
  • sourcery-ai[bot] (3)
  • melissadjadoun (2)
  • tpollina (1)
  • gromain (1)
  • dnberlin (1)
  • clatrellu (1)

Top Issue Labels

  • software (101)
  • bug (61)
  • enhancement (58)
  • documentation (27)
  • good first issue (17)
  • hardware (13)
  • proposal (7)
  • wontfix (6)
  • ui (5)
  • question (1)

Top Pull Request Labels

  • dependencies (92)
  • python (63)
  • github_actions (24)
  • documentation (12)
  • software (6)
  • docker (5)

Dependencies

.github/workflows/documentation-build.yml actions
  • actions/checkout v4 composite
  • actions/setup-python v4 composite
  • actions/upload-artifact v3 composite
  • docker/build-push-action v5 composite
  • docker/login-action v3 composite
  • docker/metadata-action v5 composite
  • docker/setup-buildx-action v3 composite
  • docker/setup-qemu-action v3 composite
.github/workflows/documentation-deploy-edge.yml actions
  • actions/checkout v4 composite
  • actions/configure-pages v3 composite
  • actions/deploy-pages v2 composite
  • actions/setup-python v4 composite
  • actions/upload-pages-artifact v2 composite
documentation/Dockerfile docker
  • caddy 2.7.4 build
software/node-red-dashboard/package-lock.json npm
  • @socket.io/component-emitter 3.1.0
  • @types/cookie 0.4.1
  • @types/cors 2.8.13
  • @types/node 20.5.6
  • accepts 1.3.8
  • base64id 2.0.0
  • bytes 3.0.0
  • compressible 2.0.18
  • compression 1.7.4
  • cookie 0.4.2
  • cors 2.8.5
  • debug 2.6.9
  • debug 4.3.4
  • depd 2.0.0
  • destroy 1.2.0
  • ee-first 1.1.1
  • encodeurl 1.0.2
  • engine.io 6.5.2
  • engine.io-parser 5.2.1
  • escape-html 1.0.3
  • etag 1.8.1
  • fresh 0.5.2
  • fs-extra 7.0.1
  • graceful-fs 4.2.11
  • gridstack 0.6.4
  • http-errors 2.0.0
  • inherits 2.0.3
  • inherits 2.0.4
  • jquery 3.7.0
  • jsonfile 4.0.0
  • mime 1.6.0
  • mime-db 1.52.0
  • mime-types 2.1.35
  • ms 2.1.2
  • ms 2.0.0
  • ms 2.1.3
  • mustache 4.2.0
  • negotiator 0.6.3
  • node-gpsd 0.3.4
  • node-red-contrib-dir2files 0.3.0
  • node-red-contrib-gpsd 1.0.7
  • node-red-contrib-python3-function 0.0.4
  • node-red-contrib-ui-multistate-switch 1.2.3
  • node-red-dashboard 3.5.0
  • node-red-node-pi-gpio 2.0.6
  • node-red-node-ui-list 0.3.6
  • object-assign 4.1.1
  • on-finished 2.4.1
  • on-headers 1.0.2
  • parseurl 1.3.3
  • path 0.12.7
  • process 0.11.10
  • range-parser 1.2.1
  • safe-buffer 5.1.2
  • send 0.18.0
  • serve-static 1.15.0
  • setprototypeof 1.2.0
  • socket.io 4.7.2
  • socket.io-adapter 2.5.2
  • socket.io-parser 4.2.4
  • statuses 2.0.1
  • toidentifier 1.0.1
  • universalify 0.1.2
  • util 0.10.4
  • vary 1.1.2
  • ws 8.11.0
software/node-red-dashboard/package.json npm
  • node-red-contrib-dir2files ^0.3.0
  • node-red-contrib-gpsd ^1.0.4
  • node-red-contrib-python3-function ^0.0.4
  • node-red-contrib-ui-multistate-switch ^1.2.2
  • node-red-dashboard ^3.1.2
  • node-red-node-pi-gpio ^2.0.1
  • node-red-node-ui-list ^0.3.6
documentation/poetry.lock pypi
  • babel 2.12.1
  • beautifulsoup4 4.12.2
  • certifi 2023.7.22
  • charset-normalizer 3.2.0
  • click 8.1.7
  • colorama 0.4.6
  • csscompressor 0.9.5
  • dnspython 2.4.2
  • ghp-import 2.1.0
  • htmlmin2 0.1.13
  • idna 3.4
  • imgp 2.8
  • importlib-metadata 6.8.0
  • jinja2 3.1.2
  • jsmin 3.0.1
  • linkchecker 10.2.1
  • markdown 3.4.4
  • markupsafe 2.1.3
  • mergedeep 1.3.4
  • mkdocs 1.5.2
  • mkdocs-charts-plugin 0.0.10
  • mkdocs-glightbox 0.3.4
  • mkdocs-macros-plugin 1.0.4
  • mkdocs-markdownextradata-plugin 0.2.5
  • mkdocs-material 9.2.8
  • mkdocs-material-extensions 1.1.1
  • mkdocs-minify-plugin 0.7.1
  • mkdocs-redirects 1.2.1
  • packaging 23.1
  • paginate 0.5.6
  • pastel 0.2.1
  • pathspec 0.11.2
  • pillow 10.0.0
  • platformdirs 3.10.0
  • poethepoet 0.22.1
  • pygments 2.16.1
  • pymdown-extensions 10.3
  • python-dateutil 2.8.2
  • pytz 2023.3.post1
  • pyyaml 6.0.1
  • pyyaml-env-tag 0.1
  • regex 2023.8.8
  • requests 2.31.0
  • six 1.16.0
  • soupsieve 2.5
  • termcolor 2.3.0
  • tomli 2.0.1
  • urllib3 2.0.4
  • watchdog 3.0.0
  • zipp 3.16.2
documentation/pyproject.toml pypi
  • python ^3.8

Score: 6.99942246750796