Features

Development status

ECCpy has been used extensively for the analysis of LD50 assays by bachelor, master and PhD students within the lab of Dieter Langosch at the Technical University of Munich in Germany. However this software is released “as is”, and may contain bugs related to particular data types, python versions or operating systems.

Installation

pip install eccpy

ECCpy is written for python 3. We recommend the Anaconda python distribution, which contains all the required python packages (numpy, scipy, pandas and matplotlib). If you encounter dependency issues, we suggest creating a python virtual environment with conda or virtualenv, and installing the exact package versions specified in the requirements.txt

Usage

As described in the wiki, ECCpy requires only the following three steps:

1) Prepare your data.

• use the excel or microplate templates in the eccpy/templates folder

• for the generic excel format, simply open the template and paste in your dose and response data.

2) Update an excel settings file

• copy the ECCpy_settings_template.xlsx from eccpy/templates

• open the excel file, input the name and location of your datafiles, and the desired location for your output files

• write “TRUE” next to the files you want to examine

3) Run ECCpy

• run the ipython/jupyter notebook, which opens a python interpreter in your web browser

• paste in the following four lines. Replace the location of your settings file.

• hit Ctrl-Enter to run

• based on your output, adjust the quality thresholds in the settings file to suit your data

Example:

import eccpy
settings = r"D:\data\ECCpy_settings.xlsx"
eccpy.run_curvefit(settings)
eccpy.run_gatherer(settings)

Test

• before processing your own data, run eccpy on the provided example files provided, following the instructions in the ECCpy wiki.

• example data is available in eccpy/examples/example_data

• example settings are available in eccpy/examples/example_settings

• TIP: when downloading ECCpy from github, run pytest in the ECCpy repository directory to automatically start functional tests

ECCpy output

run_curvefit program

• individual dose-response curves

• automatic judging of data quality

• daily summary curves, barchart and more!

run_gatherer program

• combines data from multiple experiments

• excludes EC50 values that are not of sufficient quality, according to user-defined thresholds

• bar charts with mean and SEM over all selected experiments

• scatter plots showing individual datapoints for each day/experiment, and more!

compare_rawdata program

• collects raw data and dose-response curves from multiple experiments

• compares datapoints and fitted curves between the selected samples

Contribute

If you encounter a bug or ECCpy doesn’t work for any reason, please send an email to Mark Teese (contact details below) or initiate an issue in Github.

Non-programmers can contribute by:

• testing ECCpy with your particular datasets

• suggesting features

• improving the readme and documentation

Pull requests are also very welcome.

License

ECCpy is free software distributed under the permissive MIT license.

Releases

Release-notes are found in /docs/releases.rst

Citation

If you use ECCpy in your research, please use the following citation.

Schanzenbach C, Schmidt FC, Breckner P, Teese MG, & Langosch D (2017) Identifying ionic interactions within a membrane using BLaTM, a genetic tool to measure homo-and heterotypic transmembrane helix-helix interactions. Scientific Reports 7(7):43476.

https://www.ncbi.nlm.nih.gov/pubmed/28266525

Contact

ECCpy is currently maintained by Mark Teese of TNG Technology Consulting GmbH, formerly of the Langosch lab of the Technical University of Munich.

For contact details, see the image below.