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, 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

  • 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.1.2.tar.gz (8.4 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.1.2-py3-none-any.whl (7.4 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for vsa_explainer-0.1.2.tar.gz
Algorithm Hash digest
SHA256 2525e5afcf6095e998b654aa1e60a0d6db32ce203494e1fb5583f0e82517ab0b
MD5 b92c9eda4bafea652f3c2b169e7c5717
BLAKE2b-256 728a8ef4e03ebfda9dd6bedfb0dc13482db9178d3883ceba2a873ea6c08198d6

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for vsa_explainer-0.1.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d4196b7e7b0a22de21c8eb773a3a10bf4197bdf29f0001aa385fd8f491720fad
MD5 53574cb7de81b5bb61d15ba0ada9af4b
BLAKE2b-256 c6190327fd0f8ba000f4e133fd8a728f03bcf8423879d5ccf9040a44863c5946

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