Skip to main content

TKSA - Electrostatic Free Energy calculation for each ionizable residue

Project description

TKSA-MC (Python 3)

Tanford-Kirkwood Surface Accessibility - Monte Carlo

This software calculates protein charge-charge interactions via the Tanford-Kirkwood Surface Accessibility model, using either an Exact method (for small systems) or Monte Carlo sampling (for larger systems) to determine protonation states and electrostatic free energies.

Description

This is a Python 3 port of the original TKSA-MC code. It uses mdtraj for structure parsing and SASA calculation, and numpy/numba for efficient computation of electrostatic energies.

The method calculates the electrostatic free energy contribution ($\Delta G_{qq}$) for each ionizable residue.

Requirements

  • Python 3.x
  • numpy
  • scipy
  • matplotlib
  • mdtraj
  • numba (for performance optimization of MC solver)

Install dependencies:

pip install numpy scipy matplotlib mdtraj numba

Installation

You can install the package using pip:

pip install .

This will make the tksamc command available in your terminal.

Usage

Method 1: Installed Package

Run the tksamc command:

tksamc -f sample_pdb_1ubq.pdb -ph 7.0 -T 300.0 -s MC

Method 2: Running Locally (No Install)

If you prefer not to install the package (e.g., for development or testing), you can use the run_local.py script provided in the root directory:

python3 run_local.py -f sample_pdb_1ubq.pdb -ph 7.0 -T 300.0 -s MC

Alternatively, run as a module:

python3 -m tksamc.cli -f sample_pdb_1ubq.pdb -ph 7.0 -T 300.0 -s MC

Arguments

  • -f: Input PDB file.
  • -ph: pH value (default: 7.0).
  • -T: Temperature in Kelvin (default: 300.0).
  • -s: Solver method. Choices: EX (Exact) or MC (Monte Carlo). Default: MC.
  • -e: Electrostatic method. Default: TK.
  • -plot: Generate plot (yes or no). Default: yes.
  • -aref: Reference Max SASA set (header or mdtraj). header uses legacy values. mdtraj uses theoretical values for Bondi radii (Tien et al. 2013). Default: header.

Output

  • CSV File: A CSV file (e.g., Output_MC_sample_pdb_1ubq_pH_7.0_T_300.0.csv) containing detailed results for each charged residue, including coordinates, pKa, SASA, Charge, and $\Delta G_{qq}$.
  • Plot: A JPG plot (e.g., Fig_MC_sample_pdb_1ubq_pH_7.0_T_300.0.jpg) showing the electrostatic free energy per residue. Red bars indicate positive values (unfavorable), and blue bars indicate negative values (favorable).

References

"TKSA-MC: A Web Server for rational mutation through the optimization of protein charge interactions - Vinícius G Contessoto, Vinícius M de Oliveira, Bruno R Fernandes, Gabriel G Slade, Vitor B. P. Leite, bioRxiv 221556; doi: https://doi.org/10.1101/221556"

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

tksamc-1.0.1.tar.gz (14.2 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tksamc-1.0.1-py3-none-any.whl (13.0 kB view details)

Uploaded Python 3

File details

Details for the file tksamc-1.0.1.tar.gz.

File metadata

  • Download URL: tksamc-1.0.1.tar.gz
  • Upload date:
  • Size: 14.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.8

File hashes

Hashes for tksamc-1.0.1.tar.gz
Algorithm Hash digest
SHA256 54bd50b801ae8d25b3759c79698a3bc0c8c272a009b359a7f5fbfd8efa55c187
MD5 7bd783c29359b9f5d8b277eba019b1e7
BLAKE2b-256 5704b77f9c60e131024b4f17719c3a5ff69a7e433756eae50eb5dcb72ba46387

See more details on using hashes here.

File details

Details for the file tksamc-1.0.1-py3-none-any.whl.

File metadata

  • Download URL: tksamc-1.0.1-py3-none-any.whl
  • Upload date:
  • Size: 13.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.11.8

File hashes

Hashes for tksamc-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9a11c9d81a1394007b93fcf44df9a73b707962e8ee54046566d5102af7519ebf
MD5 e1541739457730046010c599016041f3
BLAKE2b-256 c2795e73c2515368145d229363c80b348d833a2380944a0f9933f8109a079823

See more details on using hashes here.

Supported by

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