Skip to content

Commit bedc2bd

Browse files
authored
Update README.md
1 parent 361b308 commit bedc2bd

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

README.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -63,6 +63,19 @@ docker run --rm --name mcs_bead_proj -p 8050:8050 -v $(pwd):/app -v ~/mcs_bead_p
6363

6464
### Components
6565

66+
#### Data Preparation
67+
68+
This program extracts the data from the excel (`.xls`) files, stored in the `data` folder.
69+
70+
The naming scheme, the extractor will look for is: `<date>_M<microscope>_O<objective>_T<test>_S<bead_size>_B<bead_number>`. Either the filename itself or any parent folders of the file should contain the naming scheme. For example, from both of the followings, data can be extracted:
71+
```
72+
/Path/A/B/C/20250108_MAndorDragonfly_O100x1.45_TChromDual_S1.0_B0_other_text.xls
73+
/Path/20250108_MAndorDragonfly_O100x1.45_TChromDual_S1.0_B0/A/B/file.xls
74+
```
75+
76+
The simplest way of preparing data possibly be to just modify the folder name in `Bead` level directory that complies with `<date>_M<microscope>_O<objective>_T<test>_S<bead_size>_B<bead_number>` format, and leave the rest as it is.
77+
Also, please note, the <date> should contain the format of `YYYYMMDD`.
78+
6679
#### Microscopy Bead Project App
6780

6881
Web app can be accessed from your browser with: http://localhost:8050/

0 commit comments

Comments
 (0)