Skip to main content

vsa_explainer Logo

vsa_explainer: A simple Python package to visualize and explain RDKit SlogP_VSA, SMR_VSA, PEOE_VSA, EState_VSA, VSA_EState descriptor and atomic contributions


PyPI Python Python Tests Repo Size


📌 Installation

pip install vsa_explainer

📌 Quick Usage

from vsa_explainer import visualize_vsa_contributions

# Highlight per-atom contributions to SMR_VSA7 and EState_VSA5
smiles = "C1CO[C@@H]1CN2C3=C(C=CC(=C3)C(=O)O)N=C2CN4CCC(CC4)C5=NC(=CC=C5)OCC6=C(C=C(C=C6)C#N)F"
visualize_vsa_contributions(smiles, ["SMR_VSA7", "EState_VSA5"])

vsa_explainer output 1

vsa_explainer output 2

  • Draws an SVG of your molecule with atoms colored by their contribution to each selected VSA descriptor.
  • Displays a table reporting per-atom values, contributions, and percentage of the total.

📌 Support

  • SMR_VSA
    MOE-type descriptors using MR contributions and surface area contributions

  • SlogP_VSA
    MOE-type descriptors using LogP contributions and surface area contributions

  • PEOE_VSA
    MOE-type descriptors using partial charges and surface area contributions

  • EState_VSA
    MOE-type descriptors using EState indices and surface area contributions (developed at RD, not described in the CCG paper)

  • VSA_EState
    MOE-type descriptors using EState indices and surface area contributions (developed at RD, not described in the CCG paper)

📌 Contributing

  1. Fork the repo
  2. Create your feature branch (git checkout -b feature/YourFeature)
  3. Commit your changes (git commit -m "Add feature")
  4. Push to the branch (git push origin feature/YourFeature)
  5. Open a Pull Request

📌 License

Released under the MIT License. See LICENSE for details.

✨ Enjoy exploring molecular surface areas with vsa_explainer!

Metadata

Release files for vsa-explainer 0.2.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for vsa-explainer 0.2.0
File Size Uploaded
vsa_explainer-0.2.0.tar.gz 9.0 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for vsa-explainer 0.2.0
File Interpreter ABI Platform
vsa_explainer-0.2.0-py3-none-any.whl Python 3 none any Details

Total release size: 16.9 kB

Release files / vsa_explainer-0.2.0.tar.gz

Download URL vsa_explainer-0.2.0.tar.gz
Size 9.0 kB
Tags Source
SHA-256 checksum
How to use checksums
24298f8be6332b1afc0d9fadf2009437cd4f7c06e2e281ab84595af60e5cd64c
BLAKE2b-256 checksum
How to use checksums
081dd4655aef334407a70aabde94c3655a1e1445e3f1067358847e85d95db31a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.4

Release files / vsa_explainer-0.2.0-py3-none-any.whl

Download URL vsa_explainer-0.2.0-py3-none-any.whl
Size 7.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9a85fe7f876d3496a372577d6fd9fd754f3e99add1ceec0dc07a4b71dd9e314b
BLAKE2b-256 checksum
How to use checksums
abc5a132ec410371a63f46a78f3cf2874227b7f6cc7ae4969ee8987bf4fd823d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.12.4

Release history Release notifications | RSS feed

This release

0.2.0 This release

2 release files

0.1.3

2 release files

0.1.2

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page