Skip to main content

Visualize and explain RDKit VSA descriptor contributions

Project description

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!

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

vsa_explainer-0.2.0.tar.gz (9.0 kB view details)

Uploaded Source

Built Distribution

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

vsa_explainer-0.2.0-py3-none-any.whl (7.9 kB view details)

Uploaded Python 3

File details

Details for the file vsa_explainer-0.2.0.tar.gz.

File metadata

  • Download URL: vsa_explainer-0.2.0.tar.gz
  • Upload date:
  • Size: 9.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for vsa_explainer-0.2.0.tar.gz
Algorithm Hash digest
SHA256 24298f8be6332b1afc0d9fadf2009437cd4f7c06e2e281ab84595af60e5cd64c
MD5 8de7ff75cdce02367c44fbf41458d8f5
BLAKE2b-256 081dd4655aef334407a70aabde94c3655a1e1445e3f1067358847e85d95db31a

See more details on using hashes here.

File details

Details for the file vsa_explainer-0.2.0-py3-none-any.whl.

File metadata

  • Download URL: vsa_explainer-0.2.0-py3-none-any.whl
  • Upload date:
  • Size: 7.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.12.4

File hashes

Hashes for vsa_explainer-0.2.0-py3-none-any.whl
Algorithm Hash digest
SHA256 9a85fe7f876d3496a372577d6fd9fd754f3e99add1ceec0dc07a4b71dd9e314b
MD5 df8b20aec68323cdd8f03ec999d2d97d
BLAKE2b-256 abc5a132ec410371a63f46a78f3cf2874227b7f6cc7ae4969ee8987bf4fd823d

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