Welcome to YaPyCon’s documentation!

YaPyCon embeds a Python console in YASARA, “…a molecular-graphics, -modeling and -simulation program for Windows, Linux, MacOS and Android” thereby:

1. Enabling rapid prototyping of YASARA scripts

2. Offering common “shell” functionality such as:

   • Code auto-completion

   • Inline code documentation

   • Tighter integration with matplotlib

4. Improving and expanding certain aspects of YASARA’s Python functionality.

Contents:

• Installation
  • Quickstart
  • Installing from scratch
  • Removing YaPyCon
• Using YaPyCon
  • Launching the console
  • When “Python Console” is not available
  • Terminating the console
  • Typical use of the console
  • Caveats
• Examples
  • Hello World: YaPyCon Edition
  • Accessing YASARA’s pre-defined variables for plugins
  • Obtaining a screenshot
  • Exporting data in different formats
• Code documentation
  • yapycon.py
  • yasara_kernel.py
• Motivation
  • YASARA and its scripting capability
  • The “problem”
  • The Yasara Python Console (YaPyCon)
• Developer Notes
  • YASARA - Plugin communications
  • When is this not working?
  • Adding Remote Procedure Calling
  • Adding the yasara_kernel.py module
  • How YaPyCon works
• Current TODO List
  • Specific Items
• Appendix
  • YASARA Plugins

Indices and tables

• Index

• Module Index

• Search Page