Skip to main content

Predict per-residue FastHydroMap Fdewet and water-structure PC maps

Project description

FastHydroMap

PyPI version Python versions DOI

FastHydroMap predicts per-residue dewetting free energies (Fdewet) from protein structures and trajectories. It can also predict water structuring (PC1, PC2, PC3 of the water triplet angle distribution).

FastHydroMap overview

Quick Start

Use a fresh Python environment. Python 3.11 to 3.14 are supported.

pip install fasthydromap
fasthydromap install-torch
fasthydromap predict your_structure.pdb -o outputs/your_structure_fdewet

fasthydromap install-torch defaults to the CPU build, which is usually the right choice for current FastHydroMap workloads because SASA preprocessing dominates runtime.

Advanced installation options, Docker usage, GPU Torch variants, and release workflows are documented in INSTALL.md and PYPI_RELEASE.md.

Inputs

FastHydroMap supports:

  • Single protein structures in PDB format
  • Protein trajectories in DCD or XTC format together with a matching topology PDB

Typical usage:

# Single structure
fasthydromap predict examples/1A1U.pdb -o outputs/1A1U_fdewet
fasthydromap predict examples/1A1U.pdb --quantity pc1 -o outputs/1A1U_pc1

# Trajectory
fasthydromap predict-trajectory examples/proteinG.pdb examples/proteinG_short.dcd -o outputs/proteinG_fdewet

The default --quantity fdewet predicts dewetting free energy. Use --quantity pc1, --quantity pc2, or --quantity pc3 to predict water-structure principal-component maps instead.

Outputs

For a single structure, FastHydroMap writes:

  • *.csv: one row per residue with the requested quantity; with --parts, intrinsic and context columns are included
  • *.pdb: a copy of the input structure with the requested quantity written to B-factors

For a trajectory, FastHydroMap writes wide CSV files containing one row per frame and one column per residue. Use --parts to also write intrinsic, context, and per-frame summary CSVs.

Model Scope

FastHydroMap was trained on structured single-chain proteins and the 20 canonical amino-acid chemistries. Predictions for PTMs and other non-canonical chemistries should be treated cautiously.

Visualization

FastHydroMap writes predicted values to the B-factor column of output PDBs, so you can color structures directly in molecular viewers.

ChimeraX:

color bfactor range 4,6.5 palette ^lipophilicity

Example PC map coloring in ChimeraX:

color bfactor range -8,8 palette red-white-blue # example range and palette for PC1: redder = more tetrahedral angles
color bfactor range -2,8 palette cyanmaroon # for PC2: maroon = more 90 deg angles (unstructured)
color bfactor range -2,2 palette ^lipophilicity # for PC3: yellower = fewer 50 deg angles (i.e. fewer highly coordinated waters)

PyMOL:

spectrum b, red_white_blue, minimum=4, maximum=6.5

For dynamic hydrophobicity visualization in a MD trajectory, see the teaching-oriented example script scripts/chimerax_fdewet_trajectory_example.py with a ChimeraX implementation you can adjust.

Citation

If you use FastHydroMap in your research, please cite the software release:

DOI

Lobo, S. FastHydroMap (Version 0.1.3) [Computer software]. Zenodo. https://doi.org/10.5281/zenodo.19744336

When the manuscript becomes available, please cite that as well.

Acknowledgements

Shell Lab and Shea Group

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

fasthydromap-0.1.3.tar.gz (739.2 kB view details)

Uploaded Source

Built Distribution

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

fasthydromap-0.1.3-py3-none-any.whl (734.6 kB view details)

Uploaded Python 3

File details

Details for the file fasthydromap-0.1.3.tar.gz.

File metadata

  • Download URL: fasthydromap-0.1.3.tar.gz
  • Upload date:
  • Size: 739.2 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.18

File hashes

Hashes for fasthydromap-0.1.3.tar.gz
Algorithm Hash digest
SHA256 eae464a473cfea18953b396960b98b21c5db74e3249e6ea076748b3bff206609
MD5 12802214546a7e53a316365516f45058
BLAKE2b-256 f2b1c66fc00022daaaa99b25339b54c0fdc2c75f9396ac60f4033b3274f79535

See more details on using hashes here.

File details

Details for the file fasthydromap-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: fasthydromap-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 734.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.10.18

File hashes

Hashes for fasthydromap-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 313248e94524a5c09e84357fdd24c416aded10e0b541e599e7ada170b279dfcd
MD5 7d2d04fb76a613170357d3745a0aa36f
BLAKE2b-256 bfcfeefc8f7df26e87a71f33d208058c1cabbabaa9e7c1d1e9a53b147dbe6b67

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