omic/propka
1
0
Fork 0
Code Issues Pull Requests Actions 1 Packages Projects Releases Wiki Activity

unittesting and readme update

Browse Source
This commit is contained in:
Jimmy Charnley Kromann, lat13
2012-11-19 18:36:24 +01:00
parent d882a2f5d1
commit 6886db9697
10 changed files with 8373 additions and 14 deletions
Download Patch File Download Diff File Expand all files Collapse all files

41
README.md
View File

@@ -1,8 +1,21 @@
# PROPKA 3.1
PROPKA predicts the pKa values of ionizable groups in
proteins (version 3.0) and
protein-ligand complexes (version 3.1)
based in the 3D structure.
See [propka.ki.ku.dk](http://propka.ki.ku.dk/)
for more information.
For proteins without ligands both version should produce the same result.
The method is described in the following papers, which you should cite
in publications:
* Søndergaard, Chresten R., Mats HM Olsson, Michal Rostkowski, and Jan H. Jensen. "Improved Treatment of Ligands and Coupling Effects in Empirical Calculation and Rationalization of pKa Values." Journal of Chemical Theory and Computation 7, no. 7 (2011): 2284-2295.
* Olsson, Mats HM, Chresten R. Søndergaard, Michal Rostkowski, and Jan H. Jensen. "PROPKA3: consistent treatment of internal and surface residues in empirical pKa predictions." Journal of Chemical Theory and Computation 7, no. 2 (2011): 525-537.
See [propka.ki.ku.dk](http://propka.ki.ku.dk/) for the PROPKA web server,
using the [tutorial](http://propka.ki.ku.dk/~luca/wiki/index.php/PROPKA_3.1_Tutorial)
## Installation
@@ -19,22 +32,26 @@ No installation needed. Just clone and run.
## Examples
Calculate
Calculate using pdb file
propka.py 1hpx.pdb
./propka.py 1hpx.pdb
If for some reason your setup with python3.1+ is
not located in '/usr/bin/python3', run the script
If you don't have Python 3.1 installed, but
Python 3.2 (most Ubuntu distributions), then run
propka like;
python3.2 propka.py 1hpx.pdb
python3.2 propka.py 1hpx.pdb
## Testing (for developers)
Please run test before pushing commits.
Please run 'Tests/runtest.py/ after changes before pushing commits.
## References / Citations
Please cite these references in publications:
* Søndergaard, Chresten R., Mats HM Olsson, Michal Rostkowski, and Jan H. Jensen. "Improved Treatment of Ligands and Coupling Effects in Empirical Calculation and Rationalization of pKa Values." Journal of Chemical Theory and Computation 7, no. 7 (2011): 2284-2295.
* Olsson, Mats HM, Chresten R. Søndergaard, Michal Rostkowski, and Jan H. Jensen. "PROPKA3: consistent treatment of internal and surface residues in empirical pKa predictions." Journal of Chemical Theory and Computation 7, no. 2 (2011): 525-537.