Skip to content

pyCoAn/distro

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

53 Commits
 
 
 
 
 
 

Repository files navigation

banner

Welcome to the pyCoAn GitHub Distribution Page

CoAn stands for Correlative Analysis of electron microscopy data. CoAn was originally designed for correlation-based docking of atomic models into lower-resolution densities generated by electron microscopy and image reconstruction. The distinguishing factor of the underlying docking methodology is the use of correlation statistics which explicitly accounts for measurement errors through cross-validation and allows the definition of confidence intervals for the rotational and translational parameters, thus defining a solution set of docked models, all of which are compatible with the data within their margin of error.

Since its inception, CoAn has grown significantly in scope to incorporate analysis algorithms including denoising, segmentation, and pattern recognition. It has now evolved into a python-based design framework, pyCoAn, similar in concept to Matlab, but tailor-made for Computational Analysis of electron microscopy data. pyCoAn not only incorporates much of the functionality of the original CoAn package and its extensions, it also provides seamless access to a multitude of image- and data-processing software packages with a unified interface. This allows the end-user great flexibility in data analysis and allows them to focus on the questions at hand, rather than spending time figuring out how to reformat data from package A into something package B can use. The functionality of the pyCoAn base distribution can be extended with separately distributed add-ons as well as standard Python modules.

pyCoAn is in a constant state of ongoing development, as new algorithms get incorporated and more of the original algorithms are being refactored as Python modules, along with continued work on parallelizing compute-intensive tasks.

Installation

Currently pyCoAn is only available for Linux. This binary install should work for most modern Linux distributions and contains all internal dependencies.

First, download the base distribution tar file: pycoan_base_distro

Unpack the file with tar -xf, then cd pycoan_base_install. Follow the instructions in the INSTALL file.

If you want to install add-ons, download the approriate tar files. Currently available are:

pycoan_clem_add-on: hole-based alignment of LM and EM images.
pycoan_feret_add-on: Nanodisc characterization with Feret Signatures.
pycoan_sims_add-on: Simulated tomograms of membrane embedded proteins.

Once you unpacked all add-on tar files you want with tar -xf, cd pycoan_add-on_install, cd pycoan_add-on_install and follow the instructions in the INSTALL file

Once installed, the interactive version is called by typing coan on the commandline, the batch version is called with pycoan

Repository at https://github.com/pyCoAn/distro/releases

Tutorials

MEPSi tutorial - Simulated tomograms of membrane embedded proteins
Feret Signature tutorial - Characterization of nanodisc size distributions