Skip to content

Commit 983590e

Browse files
committed
docs: updata readme and pipeline howto instructions
1 parent bb4a5e7 commit 983590e

2 files changed

Lines changed: 21 additions & 2 deletions

File tree

README.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,12 @@
11
# SNAzzy: an image processing pipeline for investigating global Synchronous Network Activity
22

3+
SNAzzy is a Python package for studying synchronous network activity (SNA) in Drosophia embryos via high-thoughput microscopy.
4+
The software includes processing raw data into individual `.tif` files, quantification of fluorescence and changes in morphology, a custom peak detection algorithm, and a GUI for data visualization and curation.
5+
36
## Getting Started
47

8+
Refer to the README files inside the `snazzy_processing` or `snazzy_analysis` packages for details on running the code.
9+
510
### Installation
611

712
The project uses [conda](https://docs.conda.io) to manage dependencies.
@@ -19,6 +24,18 @@ Activate the environment:
1924
```
2025
conda activate snazzy-env
2126
```
27+
28+
## Testing
29+
30+
Tests can be run with pytest.
31+
32+
You can run the test suite from the project’s root directory to test everything at once.
33+
Make sure the environment is active, and then run:
34+
35+
```
36+
pytest
37+
```
38+
2239
## Contributing
2340

2441
Thank you for being interested in `snazzy`!

snazzy_processing/notebooks/snazzy-processing-pipeline.ipynb

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -8,12 +8,12 @@
88
"\n",
99
"Integrates all of the modules from the package, to go from raw data to csv output.\n",
1010
"More information about each module can be found in the other Jupyter Notebooks.\n",
11-
"You should change the `dataset name` and the `img_path` at the fist cell.\n",
11+
"You should change the `dataset_name` and the `img_path` at the fist cell.\n",
1212
"\n",
1313
"If the raw data is in nd2 format, it can be converted directly using the pipeline.\n",
1414
"For other formats, the image must me converted to tif using another application, for example ImageJ.\n",
1515
"\n",
16-
"Adjust the image paths to where the nd2 file is, and where the tif file will be saved."
16+
"Adjust the image path to where the tif/nd2 file is."
1717
]
1818
},
1919
{
@@ -69,6 +69,8 @@
6969
"source": [
7070
"Visualize the regions of the individual embryos that will be cropped.\n",
7171
"If the bounding boxes don't fit the embryo, you can try changing the `thres_adjust` parameter in `slice_img.calculate_slice_coordinates`.\n",
72+
"Decreasing `thres_adjust`, which can be a negative value, tends to generate bigger boxes.\n",
73+
"\n",
7274
"The resulting image also shows the number that will be used for each embryo when saving the individual movies.\n",
7375
"\n",
7476
"If after adjust `thres_adjust` the embryos are still not framed as expected, you can use `slice_img.increase_bbox()` to control the bbox dimensions."

0 commit comments

Comments
 (0)