Skip to content

Commit 74d10da

Browse files
authored
Update README.md
1 parent ecaadba commit 74d10da

File tree

1 file changed

+9
-22
lines changed

1 file changed

+9
-22
lines changed

README.md

Lines changed: 9 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -1,25 +1,16 @@
1-
# Remoscope: an automated, low-cost, and fast malaria diagnostic system
1+
# Remoscope: a label-free imaging cytometer for malaria diagnostics
22

33
![An artistic rendition of the Remoscope](icon.png)
44

5-
[TODO] - Add figure showing workflow once finalized
6-
75
## Introduction
6+
This repository hosts instrument control software for the Remoscope, an automated and low-cost malaria diagnostic system, requiring minimal user training. The Remoscope was developed by the Bioengineering team at the Chan Zuckerberg Biohub San Francisco (CZBSF). The Remoscope images unstained fresh whole blood in liquid form and can screen up to two million red blood cells for _Plasmodium falciparum_ parasites.
87

9-
TODO [Add reference to paper once uploaded]
8+
Please see our preprint here:
109

11-
This repository houses the machine learning models and instrument control software for the Remoscope, an automated and low-cost malaria diagnostic system, requiring minimal user training. The Remoscope was developed by the Bioengineering team at the Chan Zuckerberg Biohub San Francisco (CZBSF). The Remoscope images unstained fresh whole blood in liquid form and can screen up to two million red blood cells for _Plasmodium falciparum_ parasites.
10+
![image](https://github.com/user-attachments/assets/0a6896c8-2bae-41b2-a18e-0afa75b93250)
1211

1312
The Remoscope runs off a Raspberry Pi 4 Model B 8GB and an Intel Neural Compute Stick 2 (no longer available) to accelerate on-device neural network inferencing. The instrument control software is written in Python 3.7.3.
1413

15-
## User guide
16-
17-
[TODO] - Verify that the user guide is publicly accessible (https://docs.google.com/document/d/11vunMRfG9IbehD3opIatyN18aQXaa78SdT_b89pUGIs/edit#)
18-
19-
## Mechanical model
20-
21-
[TODO] - Add Onshape link, rotating gif of onshape model here
22-
2314
## Repository structure
2415

2516
```
@@ -63,12 +54,8 @@ To start the software, navigate to ulc_mm_package/QtGUI and run `python3 oracle.
6354

6455
To use developer mode, navigate to ulc_mm_package/QtGUI and run `python3 dev_run.py`. This opens a GUI with manual hardware control for debugging purposes.
6556

66-
#### Related malaria scope repositories reference
67-
68-
1. Main: https://github.com/czbiohub/ulc-malaria-scope
69-
2. Object detection - YOGO: https://github.com/czbiohub-sf/yogo
70-
3. Autofocus - SSAF: https://github.com/czbiohub-sf/ulc-malaria-autofocus
71-
4. Data processing utilities / model evaluations: https://github.com/czbiohub-sf/lfm-data-utilities/
72-
5. Dataset definitions (sets of files defining which datasets to use for training/testing, etc.): https://github.com/czbiohub-sf/lfm-dataset-definitions/tree/main
73-
6. Thumbnail labels (stored on flexo, backed up to this repository): https://github.com/czbiohub-sf/lfm-human-labels
74-
7. Statistics utilities: https://github.com/czbiohub-sf/remo-stats-utils
57+
#### Related repositories
58+
1. Object detection - YOGO: https://github.com/czbiohub-sf/yogo
59+
2. Autofocus - SSAF: https://github.com/czbiohub-sf/ulc-malaria-autofocus
60+
3. Data processing utilities / model evaluations: https://github.com/czbiohub-sf/lfm-data-utilities/
61+
4. Statistics utilities: https://github.com/czbiohub-sf/remo-stats-utils

0 commit comments

Comments
 (0)