PyMOL launching API

ammolite.launch_pymol()

Launch PyMOL in object-oriented library mode.

This is the recommended way to launch PyMOL if no GUI is required. This function simply creates a SingletonPyMOL object, calls its start() method and sets up necessary parameters using setup_parameters().

Parameters
*argsstr

The command line options given to PyMOL.

Returns
pymolSingletonPyMOL

The started PyMOL instance. PyMOL commands can be invoked by using its cmd attribute.

ammolite.launch_interactive_pymol(*args)

Launch a PyMOL GUI with the given command line arguments.

It starts PyMOL by calling pymol.finish_launching(), reinitializes PyMOL to clear the workspace and sets up necessary parameters using setup_parameters().

Parameters
*argsstr

The command line options given to PyMOL.

Returns
pymolmodule

The pymol module. PyMOL commands can be invoked by using its cmd attribute.

ammolite.reset()

Delete all objects in the PyMOL workspace and reset parameters to defaults.

If PyMOL is not yet running, launch PyMOL in object-oriented library mode.