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.1.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.1-py3-none-any.whl (5.1 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vdw_surfgen-0.4.1.tar.gz
Algorithm Hash digest
SHA256 eb7f8cdf4bd0414bf31d76b1546885d9254b43ef732852ef37c672eadf3dd91a
MD5 2578d5978898846f4223d9de163a7eea
BLAKE2b-256 d5c856d9289c63a63c172ba1065c78c5c64e86e438548a0cd2ba758d21cf46d6

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vdw_surfgen-0.4.1-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.12.1

File hashes

Hashes for vdw_surfgen-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 9d55bc1854d84a381c4ef35c2645d0747242ac1af888538d192b6bc7517435a9
MD5 71ff852bb549550116cb7b50d3f0ff92
BLAKE2b-256 c6d68277d6ad89986897ee748399b647a9c1fde9e749cb606a41afd9f431e995

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