Skip to main content

A python module for flexible Poisson-Boltzmann based pKa calculations with proton tautomerism

Project description

Open In Colab CircleCI Codacy Badge Documentation Status

PyPI version PyPI - Downloads

PypKa

A python module for flexible Poisson-Boltzmann based pKa calculations with proton tautomerism DOI: 10.1021/acs.jcim.0c00718

@article{reis2020jcim,
author = {Reis, Pedro B. P. S. and Vila-Viçosa, Diogo and Rocchia, Walter and Machuqueiro, Miguel},
title = {PypKa: A Flexible Python Module for Poisson–Boltzmann-Based pKa Calculations},
journal = {Journal of Chemical Information and Modeling},
volume = {60},
number = {10},
pages = {4442-4448},
year = {2020},
doi = {10.1021/acs.jcim.0c00718}
}

Documentation & Basic Usage

Documentation can be found here

Starting templates for the the API and CLI usage can be found here while a online notebook is hosted at Google Colab

Installation & Dependencies

PypKa should be installed in a Linux-based system. In Windows please use the WSL.

  • python2.6>= & python3.5>=
  • libgfortran4
  • gawk
  • pytest
  • numpy
  • delphi4py
  • pdbmender
  python3 -m pip install pypka
  apt install gawk gcc gfortran libgfortran4 python2

A docker image is also available. A simple way of using it would be to build the image from the Dockerfile and running it on a local directory which contains the cli parameters file and input structure.

docker build -t pypka/latest -f Dockerfile .
docker run -v ${PWD}:/home/ -w /home -t pypka:latest python3.9 -m pypka <PARAMETERS_FILE>

Functioning working examples of the API, CLI, docker and notebook can be found under /examples.

Contributing

Contributions are encouraged, and they are greatly appreciated!

You can contribute in many ways:

  • Report Bugs
  • Fix Bugs
  • Implement Features
  • Write Documentation
  • Submit Feedback

For more info check CONTRIBUTING

License

pypka is distributed under a LGPL-3.0, however delphi4py depends on DelPhi which is proprietary. To use DelPhi the user is required to download the DelPhi license here

Contacts

Please submit a github issue to report bugs and to request new features. Alternatively you may find the developer here. Please visit ou website for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

pypka-2.5.0.tar.gz (2.4 MB view details)

Uploaded Source

Built Distribution

pypka-2.5.0-py3-none-any.whl (2.5 MB view details)

Uploaded Python 3

File details

Details for the file pypka-2.5.0.tar.gz.

File metadata

  • Download URL: pypka-2.5.0.tar.gz
  • Upload date:
  • Size: 2.4 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.10 CPython/3.6.14 Linux/5.4.0-81-generic

File hashes

Hashes for pypka-2.5.0.tar.gz
Algorithm Hash digest
SHA256 4cfa93c798ba747455a83af72dc9b454f7877a41fe955b8733629086bf9974a0
MD5 031028eb29c7f98411ec844e8f16e663
BLAKE2b-256 4d1559a35eced92aa76f383c0d7c04843ff40efcd43bb75ba58b43955eecccb8

See more details on using hashes here.

File details

Details for the file pypka-2.5.0-py3-none-any.whl.

File metadata

  • Download URL: pypka-2.5.0-py3-none-any.whl
  • Upload date:
  • Size: 2.5 MB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.10 CPython/3.6.14 Linux/5.4.0-81-generic

File hashes

Hashes for pypka-2.5.0-py3-none-any.whl
Algorithm Hash digest
SHA256 27eb0eaaaf9d6f767ce0578de9cd9b27ed083a603e2afed41bb7f81d25743c58
MD5 636bc0a91a38df9f455986f27f2d7fc4
BLAKE2b-256 a59c2c28915e54f183965d2497b2706b21b513ece5b026f04f3d43c1a96006bf

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page