The Continuous Symmetry Measure for Proteins
Project description
# ProteinCSM
## INTRODUCTION
The ProteinCSM program calculates continuous symmetry and chirality measures of protein homomers in pdb format.
Please note that pdb files should be cleaned prior to calculation. Our code pdb_prep can be used for this purpose (https://sagivba.github.io/pdb_prep).
## USAGE
After installation, the program can be called from the command line. For example:
`proteincsm c2 inputmol.pdb output.pdb --optional-args`
You can access a help menu with a list of all available options via `proteincsm -h`
## INSTALLATION
proteincsm can be installed on Windows and Linux machines.
### REQUIREMENTS
Before installing CSM, please install:
* Openbabel (http://openbabel.org/wiki/Category:Installation),
version 2.4.0 or later.
* openbabel's python bindings (`pip install openbabel`)
* numpy (`pip install numpy`)
Because installing openbabel correctly is a delicate and bug-prone process, an alternative method of installing
ProteinCSM is available using Conda, and is described in the file conda_install_instructions.txt
### INSTALLATION
CSM can be installed using:
`pip install proteincsm`
You can also install ProteinCSM from the source.
## CITATIONS
Please cite ProteinCSM using the following:
proteincsm:
> Tuvi-Arad I. and Alon G., "Improved Algorithms for Quantifying the Near Symmetry of Proteins: Complete Side Chains Analysis" (submitted).
> Dryzun C., Zait A. and Avnir D., "Quantitative Symmetry and Chirality - A Fast Computational Algorithm for Large Structures: Proteins, Macromolecules, Nanotubes, and Unit Cells", J. Comput. Chem., 32, 2526-2538 (2011).
Exact Algorithm for calculating the CSM of molecules:
> Alon G. and Tuvi-Arad I., "Improved algorithms for symmetry analysis: Structure preserving permutations", J. Math. Chem., 56(1), 193-212 (2018).
Original Code by Avnir and coworkers:
> Pinsky M., Dryzun C., Casanova D., Alemany P., Avnir D., "Analytical Methods for Calculating Continuous Symmetry Measures and the Chirality Measure", Journal of Computational Chemistry 29(16): 2712-2721 (2008).
> Zabrodsky H., Peleg S., Avnir D., "Continuous symmetry measures", Journal of the American Chemical Society 114(20): 7843-7851 (1992).
## CREDITS
**Science/Math:**
Dr. Inbal Tuvi-Arad, Department of Natural Sciences, The Open University of Israel
Dr. Gil Alon, Department of Mathematics and Computer Science, The Open University of Israel
Prof. David Avnir, Institute of Chemistry, The Hebrew University of Jerusalem
**Programming:**
The Research Software Company (www.chelem.co.il)
**Testing, scripts and additional technical support:**
Sagiv Barhoom,The Open University of Israel
**Intensive testing:**
Yaffa Shalit, The Open University of Israel
The code for the hungarian algorithm is copyright (c) 2012, Jacob Frelinger
## CONTACT
Dr. Inbal Tuvi-Arad, Department of Natural Sciences, The Open University of Israel, E-mail: inbaltu@openu.ac.il
## INTRODUCTION
The ProteinCSM program calculates continuous symmetry and chirality measures of protein homomers in pdb format.
Please note that pdb files should be cleaned prior to calculation. Our code pdb_prep can be used for this purpose (https://sagivba.github.io/pdb_prep).
## USAGE
After installation, the program can be called from the command line. For example:
`proteincsm c2 inputmol.pdb output.pdb --optional-args`
You can access a help menu with a list of all available options via `proteincsm -h`
## INSTALLATION
proteincsm can be installed on Windows and Linux machines.
### REQUIREMENTS
Before installing CSM, please install:
* Openbabel (http://openbabel.org/wiki/Category:Installation),
version 2.4.0 or later.
* openbabel's python bindings (`pip install openbabel`)
* numpy (`pip install numpy`)
Because installing openbabel correctly is a delicate and bug-prone process, an alternative method of installing
ProteinCSM is available using Conda, and is described in the file conda_install_instructions.txt
### INSTALLATION
CSM can be installed using:
`pip install proteincsm`
You can also install ProteinCSM from the source.
## CITATIONS
Please cite ProteinCSM using the following:
proteincsm:
> Tuvi-Arad I. and Alon G., "Improved Algorithms for Quantifying the Near Symmetry of Proteins: Complete Side Chains Analysis" (submitted).
> Dryzun C., Zait A. and Avnir D., "Quantitative Symmetry and Chirality - A Fast Computational Algorithm for Large Structures: Proteins, Macromolecules, Nanotubes, and Unit Cells", J. Comput. Chem., 32, 2526-2538 (2011).
Exact Algorithm for calculating the CSM of molecules:
> Alon G. and Tuvi-Arad I., "Improved algorithms for symmetry analysis: Structure preserving permutations", J. Math. Chem., 56(1), 193-212 (2018).
Original Code by Avnir and coworkers:
> Pinsky M., Dryzun C., Casanova D., Alemany P., Avnir D., "Analytical Methods for Calculating Continuous Symmetry Measures and the Chirality Measure", Journal of Computational Chemistry 29(16): 2712-2721 (2008).
> Zabrodsky H., Peleg S., Avnir D., "Continuous symmetry measures", Journal of the American Chemical Society 114(20): 7843-7851 (1992).
## CREDITS
**Science/Math:**
Dr. Inbal Tuvi-Arad, Department of Natural Sciences, The Open University of Israel
Dr. Gil Alon, Department of Mathematics and Computer Science, The Open University of Israel
Prof. David Avnir, Institute of Chemistry, The Hebrew University of Jerusalem
**Programming:**
The Research Software Company (www.chelem.co.il)
**Testing, scripts and additional technical support:**
Sagiv Barhoom,The Open University of Israel
**Intensive testing:**
Yaffa Shalit, The Open University of Israel
The code for the hungarian algorithm is copyright (c) 2012, Jacob Frelinger
## CONTACT
Dr. Inbal Tuvi-Arad, Department of Natural Sciences, The Open University of Israel, E-mail: inbaltu@openu.ac.il
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
proteincsm-1.0.0.tar.gz
(986.0 kB
view details)
Built Distribution
File details
Details for the file proteincsm-1.0.0.tar.gz
.
File metadata
- Download URL: proteincsm-1.0.0.tar.gz
- Upload date:
- Size: 986.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.5.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 388a2a8887da04f72e067108fbcd6ee0b416ed88458b68e81b86cb42601512dc |
|
MD5 | fbacb822d6f3913d4aba2b248b21005e |
|
BLAKE2b-256 | 22363f03665acd5279408b81ce99ec265a547590912fc3a52d144420af43df89 |
File details
Details for the file proteincsm-1.0.0-cp35-cp35m-win_amd64.whl
.
File metadata
- Download URL: proteincsm-1.0.0-cp35-cp35m-win_amd64.whl
- Upload date:
- Size: 667.1 kB
- Tags: CPython 3.5m, Windows x86-64
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.13.0 pkginfo/1.5.0.1 requests/2.21.0 setuptools/41.0.0 requests-toolbelt/0.9.1 tqdm/4.31.1 CPython/3.5.4
File hashes
Algorithm | Hash digest | |
---|---|---|
SHA256 | 2563a201ffbbb3da1f40cdccc22ea825d05b0d0ec3340e2b141edf64b7b8e584 |
|
MD5 | 4b67d34bba890b5d4a3bf3520d9017af |
|
BLAKE2b-256 | 7c1a0f2b32338bcf568dd2a112c4bd9f6b7eddbc1b24740b511f3c55e2490347 |