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
  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.4.1.tar.gz (2.7 MB view details)

Uploaded Source

Built Distribution

pypka-2.4.1-py3-none-any.whl (2.9 MB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: pypka-2.4.1.tar.gz
  • Upload date:
  • Size: 2.7 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.4.1.tar.gz
Algorithm Hash digest
SHA256 7786d5b8dc8cb9f19fac8b9d4647bc4574ab3efcbaec03bc6b43e0a1cc1c971c
MD5 44ba7241a3e28a0ea0ba41723177583e
BLAKE2b-256 8a0e5a4466a6feeda3d1ce87e0f581843144833827f115def700b0854c48dbac

See more details on using hashes here.

File details

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

File metadata

  • Download URL: pypka-2.4.1-py3-none-any.whl
  • Upload date:
  • Size: 2.9 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.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 5a4887d5cc1226425a291627ad4e916398ea4696e349d047e6ee7c7bc8a7d191
MD5 cb6f33ba7e47c46edc4d47bdb42bb700
BLAKE2b-256 6a047de4e1f23941dfa32943a4cc2e4c2bd5a9dc0b49c7f280dc6d566cf92297

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