search

retroam / Calcium-analysis

Python implementation of calcium imaging analysis pipeline for cardiac myocytes
0 stars 0 forks source link

Sweep: modify README to provide instructions on using the package #16

Closed retroam closed 1 year ago

retroam commented 1 year ago

Focus on files in:Calcium-analysis/calcium_analysis

sweep-ai[bot] commented 1 year ago

Hey @retroam,

I've started working on this PR. The plan is to update the README file with a new section titled "How to use this package". This section will provide step-by-step instructions on how to install the package, how to run the scripts, and what each script does. I'll include code snippets where necessary to make things as clear as possible.

Give me a minute!

Some code snippets I looked at (click to expand). If some file is missing from here, you can mention the path in the ticket description. https://github.com/retroam/Calcium-analysis/blob/ced3c082f283b7e80b069c35c444d23d33870653/tests/test_data_extraction.py#L1-L17 https://github.com/retroam/Calcium-analysis/blob/ced3c082f283b7e80b069c35c444d23d33870653/old/stackstoroi.py#L12-L53 https://github.com/retroam/Calcium-analysis/blob/ced3c082f283b7e80b069c35c444d23d33870653/calcium_analysis/image_segmentation.py#L1-L36 https://github.com/retroam/Calcium-analysis/blob/ced3c082f283b7e80b069c35c444d23d33870653/calcium_analysis/data_extraction.py#L1-L39 https://github.com/retroam/Calcium-analysis/blob/ced3c082f283b7e80b069c35c444d23d33870653/matlab/roitodata.m#L1-L24

I'm a bot that handles simple bugs and feature requests but I might make mistakes. Please be kind!