psico.helping

(c) 2011 Thomas Holder, MPI for Developmental Biology (c) 2005-2009 Ezequiel Panepucci

License: BSD-2-Clause

Functions

api_info(name)

Get the full function name (incl.

apropos([regexp])

"apropos" searches through the documentation of all currently defined commands and lists those commands for which the keyword is either contained in the documentation or matches the command name itself.

grepset([regexp, _self])

"grepset" greps through the list of settings using a python regular expression as defined in the 're' module.

write_html_ref(filename[, prefix, format])

Write psico command reference to file.

write_txt_ref(filename[, prefix])

Write psico command and its DESCRIPTION to file as plain text.

psico.helping.api_info(name)[source]

Get the full function name (incl. module) of given command.

Arguments

name = string: name of a PyMOL command

psico.helping.apropos(regexp='')[source]

“apropos” searches through the documentation of all currently defined commands and lists those commands for which the keyword is either contained in the documentation or matches the command name itself.

If an appropriate “DESCRIPTION” section is provided in the documentation of the command, the first 80 characters are listed as a summary.

Author: Ezequiel Panepucci http://pymolwiki.org/index.php/Apropos

Usage

apropos [keyword or regexp]

See Also

grepset

psico.helping.grepset(regexp='', *, _self=...)[source]

“grepset” greps through the list of settings using a python regular expression as defined in the ‘re’ module. It returns a list of settings/values matching the regexp. No regexp returns every setting.

Author: Ezequiel Panepucci http://pymolwiki.org/index.php/Grepset

Usage

grepset [regexp]

Example

grepset line grepset ray grepset (^line|color$)

See Also

apropos

psico.helping.write_html_ref(filename, prefix='psico', format='html')[source]

Write psico command reference to file.

See Also

cmd.write_html_ref

psico.helping.write_txt_ref(filename, prefix='psico')[source]

Write psico command and its DESCRIPTION to file as plain text.

See Also

cmd.write_html_ref