Python bindings for SAMSON API

The Python Scripting extension in SAMSON provides Python bindings for SAMSON API and an integrated Python console. It provides you with an access to most of the SAMSON Developer Guide allowing you to access most of SAMSON’s functionality through Python scripting.

Python bindings for the SAMSON API are done in the same structure as the SAMSON Developer Guide: classes have the same short names as in the SDK and functions are exposed with the same names and parameters except for some getter/setter functions that are exposed as class properties where possible. This makes it possible to easily trasnfer your code between Python and C++ with minor modifications.

This documentation has links to the SAMSON Developer Guide which you can check out for comparison and some additional information.

The Python console in SAMSON comes with an integrated Jupyter Qt Console.

Note

This version of Python bindings is for SAMSON Developer Guide 2024 R1.

Python bindings are done thanks to pybind11 (pybind11 license).

Guide

The following guides demonstrate the usage of Python bindings for SAMSON API.

Guide

• Getting started
  • Importing samson module
  • Getting help
  • Saving history
  • Running scripts
  • Installing Python packages
• Running actions
  • Running actions by name
  • Selecting nodes using runCommand and NSL
  • Running actions by UUID
• Developing scripts
  • Using SAMSON AI
  • Using Code Editor
  • Embedding Python Scripts
  • Installing Python packages
  • GUI
• Working with documents and nodes
  • Documents
  • Moving around
  • Working with nodes
• Importing and exporting
• Making operations undoable
• Selecting nodes
  • Select using actions
  • Select using NSL
  • Select via nodes
  • Clear selection
  • Selection examples
• Getting nodes
• Units
  • SBQuantity
  • Type
• Colorizing nodes
  • List of color schemes
  • Apply color
  • Apply color from color palette
  • Apply color scheme
  • Apply a color scheme with a color palette
• Visualizing
  • Applying visual models
  • Applying visual presets
• Building
  • Creating a structural model
  • Creating an atom
  • Creating covalent bonds
  • Adding hydrogens
  • Minimizing systems
  • Examples
• Presenting and animating
  • List of available animations
  • How to create a presentation
  • How to create an animation
  • Exporting a movie
• Rendering
  • Rendering effects
  • Render presets
  • Rendering using Cycles
• Examples
  • Animations
  • Building systems
  • Colorizization and visualization
  • Exporting
  • Processing
  • Selections
  • Simulation
  • Apps and GUIs

API documentation

Below the Python Scripting API description is subdivided into groups that correspond to the SAMSON SDK Organization.

API

• Core
  • Class
  • Container
  • Reference
• Data Model
  • Asset
  • Color Scheme
  • Data Graph
  • Document
  • Palette
  • SBQuantity
  • Type
  • Visualization
• Facade
  • SAMSON
• GUI
  • Action
• Modeling
  • Dynamical Model
  • Element
  • Interaction Model
  • Model
  • Property Model
  • Structural Model
  • Visual Model
• Simulation
  • Neighbor Search
  • Simulator
  • State Updater

• Changelog
• All versions