CNotebook

Getting Started

  • Installation
    • Requirements
    • Installing CNotebook
    • Installing Optional Dependencies
    • OpenEye Toolkits License
    • Verifying Installation
  • Quick Start
    • Basic Molecule Rendering
    • Working with DataFrames
    • Using MolGrid
    • Customizing Rendering
    • Environment Support
    • Next Steps

User Guide

  • Basic Rendering
    • Molecules
    • Query Molecules
    • Display Objects
    • Design Units
    • Substructure Highlighting
    • Rendering Contexts
      • Global Context
      • Local Contexts
    • Environment-Specific Behavior
  • DataFrame Integration
    • Pandas Integration
      • Prerequisites
      • Creating Molecule Columns
      • Substructure Highlighting
      • Molecular Alignment
      • Fingerprint Similarity
    • Polars Integration
      • Prerequisites
      • Creating Molecule Columns
      • Reading Molecule Files
      • Substructure Highlighting
      • Molecular Alignment
      • Fingerprint Similarity
    • MolGrid from DataFrames
    • Best Practices
  • MolGrid: Interactive Molecule Grids
    • Overview
    • Basic Usage
      • Creating a Simple Grid
    • Selection
      • Enabling Selection
      • Selection Methods
      • Retrieving Selections
      • Exporting Selections
    • Customizing the Display
      • Image Settings
      • Pagination
      • Title Display
    • Search and Filtering
      • Text Search
      • SMARTS Mode (Substructure Search)
    • Info Button and Tooltips
      • Configuring Displayed Data
      • Disabling the Info Button
    • DataFrame Integration
      • Pandas
      • Automatic Field Detection
    • Viewing Clusters
    • API Reference
      • MolGrid Class
        • MolGrid
      • molgrid Function
        • molgrid()
  • C3D Interactive 3D Viewer
    • Quick Start
    • Adding Molecules
    • Adding Design Units
    • Disabled Molecules
    • View Presets
    • Custom Styles
    • Zoom Targets
    • UI Configuration
    • Background Color
    • Builder API
    • HTML Export
  • Advanced Rendering

API Reference

  • API Reference
    • cnotebook
      • LevelSpecificFormatter
        • LevelSpecificFormatter.NORMAL_FORMAT
        • LevelSpecificFormatter.DEBUG_FORMAT
        • LevelSpecificFormatter.__init__()
        • LevelSpecificFormatter.format()
      • enable_debugging()
      • CNotebookEnvInfo
        • CNotebookEnvInfo.__init__()
        • CNotebookEnvInfo.pandas_available
        • CNotebookEnvInfo.pandas_version
        • CNotebookEnvInfo.polars_available
        • CNotebookEnvInfo.polars_version
        • CNotebookEnvInfo.ipython_available
        • CNotebookEnvInfo.ipython_version
        • CNotebookEnvInfo.marimo_available
        • CNotebookEnvInfo.marimo_version
        • CNotebookEnvInfo.molgrid_available
        • CNotebookEnvInfo.c3d_available
        • CNotebookEnvInfo.is_jupyter_notebook
        • CNotebookEnvInfo.is_marimo_notebook
      • get_env()
      • display()
      • Package Overview
      • Usage
      • Module Attributes
        • cnotebook_context
      • Environment Detection
    • molgrid
      • Usage Examples
        • Basic Grid
        • Grid with DataFrame
        • Retrieving Selections
    • C3D Module
      • C3D Class
        • C3D
      • Conversion Utilities
        • MoleculeData
        • convert_molecule()
        • convert_design_unit()
    • context
      • DeferredValue
        • DeferredValue.__init__()
        • DeferredValue.reset()
        • DeferredValue.is_deferred
        • DeferredValue.get()
        • DeferredValue.set()
      • CNotebookContext
        • CNotebookContext.supported_mime_types
        • CNotebookContext.__init__()
        • CNotebookContext.width
        • CNotebookContext.height
        • CNotebookContext.min_width
        • CNotebookContext.max_width
        • CNotebookContext.max_height
        • CNotebookContext.min_height
        • CNotebookContext.structure_scale
        • CNotebookContext.atom_label_font_scale
        • CNotebookContext.title_font_scale
        • CNotebookContext.bond_width_scaling
        • CNotebookContext.image_format
        • CNotebookContext.scope
        • CNotebookContext.callbacks
        • CNotebookContext.reset_callbacks()
        • CNotebookContext.title
        • CNotebookContext.max_heavy_atoms
        • CNotebookContext.image_mime_type
        • CNotebookContext.display_options
        • CNotebookContext.add_callback()
        • CNotebookContext.create_molecule_display()
        • CNotebookContext.reset()
        • CNotebookContext.copy()
      • pass_cnotebook_context()
      • create_local_context()
      • get_series_context()
      • CNotebookContext Class
      • Usage
      • Configuration Options
        • Image Dimensions
        • Output Format
        • Scaling
    • render
      • create_img_tag()
      • oedisp_to_html()
      • render_empty_molecule()
      • render_invalid_molecule()
      • render_exceeds_max_heavy_atoms()
      • oemol_to_disp()
      • oemol_to_image()
      • oedu_to_disp()
      • oedu_to_image()
      • oemol_to_html()
      • oedu_to_html()
      • oeimage_to_html()
      • Rendering Functions
      • Key Functions
        • oemol_to_html
        • render_molecule
    • pandas_ext
      • Pandas DataFrame Accessor
      • Usage
      • DataFrame Methods
        • DataFrame.chem.as_molecule()
        • DataFrame.chem.highlight_using_column()
        • DataFrame.chem.fingerprint_similarity()
        • DataFrame.chem.molgrid()
      • Series Methods
        • Series.chem.highlight()
        • Series.chem.align_depictions()
        • Series.chem.molgrid()
    • polars_ext
      • Polars DataFrame Accessor
      • Usage
      • DataFrame Methods
      • Series Methods
    • Module Overview
      • Core Modules
      • Visualization
      • DataFrame Extensions
CNotebook
  • API Reference
  • View page source

API Reference

This section provides detailed API documentation for all CNotebook modules.

  • cnotebook
    • LevelSpecificFormatter
    • enable_debugging()
    • CNotebookEnvInfo
    • get_env()
    • display()
    • Package Overview
    • Usage
    • Module Attributes
    • Environment Detection
  • molgrid
    • Usage Examples
  • C3D Module
    • C3D Class
    • Conversion Utilities
  • context
    • DeferredValue
    • CNotebookContext
    • pass_cnotebook_context()
    • create_local_context()
    • get_series_context()
    • CNotebookContext Class
    • Usage
    • Configuration Options
  • render
    • create_img_tag()
    • oedisp_to_html()
    • render_empty_molecule()
    • render_invalid_molecule()
    • render_exceeds_max_heavy_atoms()
    • oemol_to_disp()
    • oemol_to_image()
    • oedu_to_disp()
    • oedu_to_image()
    • oemol_to_html()
    • oedu_to_html()
    • oeimage_to_html()
    • Rendering Functions
    • Key Functions
  • pandas_ext
    • Pandas DataFrame Accessor
    • Usage
    • DataFrame Methods
    • Series Methods
  • polars_ext
    • Polars DataFrame Accessor
    • Usage
    • DataFrame Methods
    • Series Methods

Module Overview

Core Modules

Module

Description

cnotebook

Main package with automatic rendering setup

context

Global rendering context and configuration

render

Core rendering functions for molecules

Visualization

Module

Description

molgrid

Interactive molecule grid visualization

C3D Module

Interactive 3D molecule viewer (3Dmol.js)

DataFrame Extensions

Module

Description

pandas_ext

Pandas DataFrame integration

polars_ext

Polars DataFrame integration

Previous Next

© Copyright 2024, Scott Arne Johnson.

Built with Sphinx using a theme provided by Read the Docs.