schrodinger.application.models.library.bundled_libraries module

class schrodinger.application.models.library.bundled_libraries.BundledLibrary

Bases: Enum

Identifiers for the bundled example libraries shipped with tests.

BUILTIN = 'builtin_library'

EXAMPLE = 'basic_example_library'

schrodinger.application.models.library.bundled_libraries.get_bundled_library_source_path(library: BundledLibrary) → Path

Return the path to a bundled library’s source files.

Parameters:

library – which bundled library.

Returns:

path to the bundled library source files.

schrodinger.application.models.library.bundled_libraries.get_example_library_source_path() → Path

Return the path to the bundled example library source files.

schrodinger.application.models.library.bundled_libraries.get_builtin_library_source_path() → Path

Return the path to the bundled builtin library source files.

schrodinger.application.models.library.bundled_libraries.copy_bundled_library(library: BundledLibrary, dest: pathlib.Path | None = None) → Path

Copy a bundled library to the given path.

If it already exists, it will be overwritten.

Parameters:

• library – which bundled library to copy.

• dest – full destination path. Defaults to CWD / default dir name.

Returns:

Path to the copied library.