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 molecule.xyz --txt --img

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

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vdw_surfgen-0.4.tar.gz
Algorithm Hash digest
SHA256 9902fb8248b6dfe9d12bb99468f57896f555eed46aedb7653b5eaca5d5e3073b
MD5 06614184de106788a870352f67d8c57e
BLAKE2b-256 a8d1b2c1632392ad37e283cad352f4d1639de6d264844c85aaf9c460e4b162d1

See more details on using hashes here.

File details

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

File metadata

  • Download URL: vdw_surfgen-0.4-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.6

File hashes

Hashes for vdw_surfgen-0.4-py3-none-any.whl
Algorithm Hash digest
SHA256 24212c7874da8b6d6ce3ee2c1c68833c94df13ee0e370adbebb7e90037b5622c
MD5 66fb09c5a6df06ac124cdae2b7fbcdd2
BLAKE2b-256 c76fa9c2fc36d33a62536016d665e27844c34267f11fa1e2ef6ff6d8960f8318

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