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
.xyzfiles - ⚛️ Compute VDW surface points using Fibonacci sphere sampling
- 🔬 Set surface density (points per Ų)
- 💾 Save results as:
.xyzpseudo-atom file (always saved).txtcoordinate file (optional).png3D 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:
- 🧬
.xyzfiles are always saved automatically - 🎨 Enjoy beautiful colored output with progress bars!
🧪 Testing
A sample test file test.xyz (FMN molecule with 50 atoms) is included. You can use it to test the functionality:
vsg test.xyz --txt --img
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file vdw_surfgen-0.3.tar.gz.
File metadata
- Download URL: vdw_surfgen-0.3.tar.gz
- Upload date:
- Size: 4.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/6.1.0 CPython/3.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
60e02c86d3e4c0ccc934288422411005112474a773c6408bceb65deee1cb3264
|
|
| MD5 |
a467506221a4b4ce0ea59488b933ebec
|
|
| BLAKE2b-256 |
8d98c1f89f3963e6851f4bb78f5b2b4dd872592c5fbdc0382baa9587e198fb66
|
File details
Details for the file vdw_surfgen-0.3-py3-none-any.whl.
File metadata
- Download URL: vdw_surfgen-0.3-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.11.7
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
dfe449ead72342d13b16e71f4ea358d48e1ecaab44bfb3b905bb7b0a4e755cf0
|
|
| MD5 |
13591f37b4340d336bdcf7ce041ca1e9
|
|
| BLAKE2b-256 |
5b182e79bd8e7ee9325b8b02eeb7d7a9955aed6f154e1c531e270a7cf1357afb
|