Module surfaces_interfaces_mod

Classes

[hide private]

ParserWrapper
Manages the argparse module to parse user command line arguments.

Surfaces
Manage the enumeration of surfaces.

Interfaces
Manage the enumeration of interfaces.

SurfacesInterfaces
Manage the enumeration of surfaces and interfaces.

Functions

[hide private]

str, str or None, str

get_base_names(ref_xtal_asu, ref_base_name_in=None, ads_xtal_asu=None, ads_base_name_in=None)
Return the reference, adsorption, and final combined base names.

list

get_word_list_from_file(afile)
Return a list of words from the given file.

dict

get_surface_kwargs(options_file)
Return a dictionary of surface options from the given options file.

dict

get_interface_kwargs(options_file)
Return a dictionary of interface options from the given options file.

Variables

[hide private]

__doc__ = ...

MSGWIDTH = 100

LATTICE_PARAM_KEYS = [xtal.Crystal.A_KEY, xtal.Crystal.B_KEY, ...

LOCALHOST = 'localhost'

Function Details

[hide private]

get_base_names(ref_xtal_asu, ref_base_name_in=None, ads_xtal_asu=None, ads_base_name_in=None)

Return the reference, adsorption, and final combined base names.

Parameters:

ref_xtal_asu (str) - reference xtal input file
ref_base_name_in (str or None) - reference base name or None if none has been given
ads_xtal_asu (str or None) - adsorption xtal input file or None if none has been given
ads_base_name_in (str or None) - adsorption base name or None if none has been given

Returns: str, str or None, str

reference, adsorption, and final combined base names, the adsorption base name will be None if no adsorption xtal asu is provided

get_word_list_from_file(afile)

Return a list of words from the given file.

Parameters:

afile (str) - file name

Returns: list

contains words from the given file

get_surface_kwargs(options_file)

Return a dictionary of surface options from the given options file.

Parameters:

options_file (str or None) - contains options for the surface build or None if there are none in which case the defaults are used

Returns: dict

contains options for the surface build

get_interface_kwargs(options_file)

Return a dictionary of interface options from the given options file.

Parameters:

options_file (str or None) - contains options for the interface build or None if there are none in which case the defaults are used

Returns: dict

contains options for the interface build

Variables Details

[hide private]

doc

Value:

"""
Classes and functions to enumerate surfaces and interfaces.

Copyright Schrodinger, LLC.  All rights reserved."""

LATTICE_PARAM_KEYS

Value:

[xtal.Crystal.A_KEY, xtal.Crystal.B_KEY, xtal.Crystal.C_KEY, xtal.Crys
tal.ALPHA_KEY, xtal.Crystal.BETA_KEY, xtal.Crystal.GAMMA_KEY]