schrodinger.utils.platform module¶
-
schrodinger.utils.platform.
validate_localhost_platform_compatibility
(compatible_platforms)¶ - Parameters
compatible_platforms (list[str]) – Compatible platforms. Use LINUX, WINDOWS or DARWIN as values for platforms.
- Raises
ValueError – If a value in
compatible_platforms
is not LINUX, WINDOWS or DARWIN.- Returns
Whether the localhost’s platform is in
compatible_platforms
. Also returns a non empty message if platform is incompatible. The return value can be used directly with af2 validators and task preprocessors.- Return type
tuple(bool, str)
-
schrodinger.utils.platform.
is_localhost_platform_compatible
(compatible_platforms)¶ - Parameters
compatible_platforms (list[str]) – Compatible platforms. Use LINUX, WINDOWS or DARWIN as values for platforms.
- Raises
ValueError – If a value in
compatible_platforms
is not LINUX, WINDOWS or DARWIN.- Returns
Whether the localhost’s platform is compatible.
- Return type
bool
-
schrodinger.utils.platform.
pluralize_text
(noun, count, suffix='s')¶ Helper function to pluralize simple nouns when necessary
- Parameters
noun (str) – singular form of the noun
count (int) – number of objects
noun
is describingsuffix (str) – letters to add to the word to make the plural form