Package schrodinger
[hide private]
[frames] | no frames]

Package schrodinger

This is the top level package for all Schrodinger modules.

The main modules of interest are schrodinger.structure and the ones in the schrodinger.structutils package.

The Python Module Overview included with the Schrodinger distribution gives an expository introduction to the Schrodinger Python API. It is available from the Help -> Python Module Overview... link in Maestro, or from the $SCHRODINGER/docs/python_api/overview.html file.

If you have questions about the API, please contact us at help@schrodinger.com.


Version: 55012

Submodules [hide private]

Classes [hide private]
  MaestroNotAvailableError
Error class to indicate that Maestro is not available and there was an attempt to use it.
  _DummyMaestroModule
Used to replace schrodinger.maestro.maestro when running outside of Maestro.
Functions [hide private]
 
get_maestro()
Get either schrodinger.maestro.maestro or an object that allows scripts to avoid running maestro dependent-code, and print reasonable errors if that code is run outside of maestro.
 
get_mmshare_version()
Return the mmshare version as a 5 digit integer.
 
get_mpl_backend_name()
Get the matplotlib backend name to use with pyplot.
 
get_release_name()
Return release name.
 
get_scisol_version()
Return the scisol version number as a 5 digit int as in version.h
 
version_at_least(v)
Check that the Schrodinger python version is at least the value 'v'.
 
version_at_most(v)
Check that the Schrodinger python version does not exceed 'v'.
 
version_compatible(minimum, maximum)
Check that the version is between minimum and maximum values.
Variables [hide private]
  __package__ = 'schrodinger'
Function Details [hide private]

get_maestro()

 

Get either schrodinger.maestro.maestro or an object that allows scripts to avoid running maestro dependent-code, and print reasonable errors if that code is run outside of maestro.

Returns:
schrodinger.maestro.maestro or _DummyMaestroModule

get_release_name()

 

Return release name.

Current use of the release name is to specify a release-specific subdirectory in the user application data directory.

version_at_least(v)

 

Check that the Schrodinger python version is at least the value 'v'. NOTE: Deprecated in favor of get_mmshare_version()

version_at_most(v)

 

Check that the Schrodinger python version does not exceed 'v'. NOTE: Deprecated in favor of get_mmshare_version()

version_compatible(minimum, maximum)

 

Check that the version is between minimum and maximum values. NOTE: Deprecated in favor of get_mmshare_version()

If the current Schrodinger python version is less than the minimum, an Exception will be raised. If the current version is greater than the maximum, a warning will be issued.