Skip to content

CardiacModelling/syncropatch_export

Repository files navigation

Unit tests codecov

Table of Contents
  1. About The Project
  2. Getting Started
  3. Usage
  4. Roadmap
  5. Contributing
  6. License
  7. Contact
  8. Acknowledgments

About The Project

This project contains a python package and scripts for processing data outputted from Nanion SynroPatch 384. With this package you can export each sweep of each protocol for each well as individual files (.csv). Meta-data describing the protocol, and variables such as membrance capacitance (Cm), Rseries and Rseal can be exported also.

(back to top)

Getting Started

This is an example of how you may give instructions on setting up your project locally. To get a local copy up and running follow these simple example steps.

Prerequisites

This package has been tested on Ubuntu with Python 3.7, 3.8, 3.9, 3.10 and 3.11.

Installation

First clone this repository

git clone [email protected]:CardiacModelling/syncropatch_export && cd syncropatch_export

With one of these versions install, create and activate a virtual environment.

python3 -m venv .venv && source .venv/bin/activate

Then install the package with pip.

python3 -m pip install --upgrade pip && python3 -m pip install -e .'[test]'

To run the tests you must first download some test data. Test data is available at cardiac.nottingham.ac.uk/syncropatch_export

wget https://cardiac.nottingham.ac.uk/syncropatch_export/test_data.tar.xz -P tests/
tar xvf tests/test_data.tar.xz -C tests/

Then you can run the tests.

python3 -m unittest

Contributing

Any contributions you make are greatly appreciated.

If you have a suggestion that would make this better, please fork the repo and create a pull request. You can also simply open an issue with the tag "enhancement".

  1. Fork the Project
  2. Create your Feature Branch (git checkout -b feature/AmazingFeature)
  3. Commit your Changes (git commit -m 'Add some AmazingFeature')
  4. Push to the Branch (git push origin feature/AmazingFeature)
  5. Open a Pull Request

(back to top)

License

(back to top)

Contact

Joseph Shuttleworth [email protected]

Project Link: https://github.com/CardiacModelling/syncropatch_export

(back to top)

(back to top)

About

A Python package to export SynroPatch 384 data.

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Languages