Skip to main content

3D visualization of small compounds

Project description

PenguinMol3D

PenguinMol3D is an open source Python3 package, which utilizes OpenGL python binding (https://pyopengl.sourceforge.net) for rendering of small compounds' 3D models.

Installation

Dependencies

  • numpy
  • rdkit
  • PyOpenGL
  • PyOpenGL_accelerate
  • glfw
  • Pillow

NOTE: Although dependencies are installed with package, on Windows OS Microsoft C++ 14 Build Tools are required to install PyOpenGL_accelerate

Usage

Initially, the RDKit Mol object is created from data in a file (e.g, MOL/SDF, MOL2 format) provided by user; the Mol object is further passed as an argument to the Mol3D class constructor, which generates a 3D model based on atom coordinates of the Mol object conformer. During the initialization stage (before running an event loop) user has to setup a scene by creating MolecularScene object and adding all necessary components like molecule and light sources as it is demonstrated in examples. As a drawing surface for rendering can be used any surface compatible with OpenGL; particularly, provided by such GUI libaries as GLFW (used in examples), PyGame, PyQt, PySide, wxPython, Tkinter + Togl widget, etc.

To check if package was installed correctly after installation enter:

Windows OS:

  • python -m PenguinMol3D.glfw_surface_example

Linux OS:

  • python3 -m PenguinMol3D.glfw_surface_example

PenguinMol3D currently supports two lighting models: Physically Based Lighting Model (default) and Blinn-Phong Lighting Model. To see examples of this two models enter:

Windows OS:

  • python -m PenguinMol3D.glfw_bpr_example
  • python -m PenguinMol3D.glfw_pbr_example
  • python -m PenguinMol3D.glfw_custom_material_example

Linux OS:

  • python3 -m PenguinMol3D.glfw_bpr_example
  • python3 -m PenguinMol3D.glfw_pbr_example
  • python3 -m PenguinMol3D.glfw_custom_material_example

Main folder also contains script, which can be used for small molecule visualization with predefined scene, to run it enter:

Windows OS:

  • python -m PenguinMol3D.display_molecule molecule_name.sdf

Linux OS:

  • python3 -m PenguinMol3D.display_molecule molecule_name.sdf

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

PenguinMol3D-0.1.2.tar.gz (47.1 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: PenguinMol3D-0.1.2.tar.gz
  • Upload date:
  • Size: 47.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.0 CPython/3.10.4

File hashes

Hashes for PenguinMol3D-0.1.2.tar.gz
Algorithm Hash digest
SHA256 f67d404e95c51d90de39dc5be93e5defd8e90e2e55bbd33d5b494919b1f6421b
MD5 854fb76423524ed3efd473cb6c8af1ab
BLAKE2b-256 bf670473f36288084dfa6056c326907476eadcbbad628598ee1427113ecc25ec

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