Skip to main content

Generate van der Waals surface points from XYZ files.

Project description

vdw-surfgen

vdw-surfgen is a Python CLI tool to generate points on the van der Waals (VDW) surface of a molecule using its XYZ geometry file.

Surface points are generated at a scaled VDW radius and can be used for visualization, machine learning, or molecular modeling.

It is inspired by Robert T. McGibbon's pyvdwsurface.

🔧 Features

  • 🧬 Read atomic coordinates from .xyz files
  • ⚛️ Compute VDW surface points using Fibonacci sphere sampling
  • 🔬 Set surface density (points per Ų)
  • 💾 Save results as:
    • .xyz pseudo-atom file (always saved)
    • .txt coordinate file (optional)
    • .png 3D scatter plot (optional)
  • 🎨 Beautiful colored terminal output with progress bars
  • ⚡ Command-line interface (CLI) with full control

🚀 Installation

pip install vdw-surfgen

🔨Usage

# Basic usage (XYZ file always saved)
vsg molecule.xyz

# With additional formats and custom parameters
vsg molecule.xyz --scale 1.2 --density 2.0 --txt --img

Options:

  • --scale: Scale factor for VDW radii (default: 1.0)
  • --density: Point density per Ų (default: 1.0)
  • --txt: Save as TXT coordinate file
  • --img: Save 3D visualization as PNG

Note:

  • 🧬 .xyz files are always saved automatically
  • 🎨 Enjoy beautiful colored output with progress bars!

🧪 Testing

You can test the functionality with any .xyz file:

vsg your_molecule.xyz --txt --img

soajagbe.

Options:

  • --scale: Scale factor for VDW radii (default: 1.0)
  • --density: Point density per Ų (default: 1.0)
  • --txt: Save as TXT coordinate file
  • --img: Save 3D scatterplot as PNG

soajagbe.

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

vdw_surfgen-0.4.2.tar.gz (4.8 kB view details)

Uploaded Source

Built Distribution

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

vdw_surfgen-0.4.2-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

Details for the file vdw_surfgen-0.4.2.tar.gz.

File metadata

  • Download URL: vdw_surfgen-0.4.2.tar.gz
  • Upload date:
  • Size: 4.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for vdw_surfgen-0.4.2.tar.gz
Algorithm Hash digest
SHA256 d407a07f51b5e507320d24501a5775595040175d59767fcad4aac2098e3d67d3
MD5 2c0d178192024699eff1e2cf9b99294e
BLAKE2b-256 256d9d5863a8f6b9253974104e6d30d99edc9954e297a734b33a88f3852b482a

See more details on using hashes here.

File details

Details for the file vdw_surfgen-0.4.2-py3-none-any.whl.

File metadata

  • Download URL: vdw_surfgen-0.4.2-py3-none-any.whl
  • Upload date:
  • Size: 5.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.9.22

File hashes

Hashes for vdw_surfgen-0.4.2-py3-none-any.whl
Algorithm Hash digest
SHA256 776f26ce1d6fd859ae31cd876c91d5778da1cef079c08ef8d15476e800a99d9c
MD5 8309e48dfc5d3d2dd58046ef5cab6168
BLAKE2b-256 3764f2255b1a36792e4e44db28d088a602b4ed2a2a24190cdbf891909be38d95

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