Topo

simulation.topo.TopoGen()

Bases: ABC

Standardized framework for generating topology files.

dry_run(path_structure, simlify_config) abstractmethod classmethod

Perform a dry run to obtain any preliminary information needed before run.

PARAMETER	DESCRIPTION
path_structure	Path structure file for topology generation. TYPE: str
simlify_config	Simlify configuration. TYPE: SimlifyConfig

RETURNS	DESCRIPTION
dict[str, Any]	Keyword arguments to be passed into run.

run(path_structure, simlify_config, **kwargs) abstractmethod classmethod

Generate a topology file.

PARAMETER	DESCRIPTION
path_structure	Path structure file for topology generation. TYPE: str
simlify_config	Simlify configuration. TYPE: SimlifyConfig

simulation.topo.cli_run_gen_topo()

Command-line interface for generating a topology file

simulation.topo.run_gen_topo(path_structure, import_string, simlify_config)

Diver function for generating a topology file.

PARAMETER	DESCRIPTION
path_structure	Path structure file for topology generation. TYPE: str
import_string	Import string to a topology generation class. For example, "simlify.simulation.amber.topo.AmberTopoGen". TYPE: str
simlify_config	Simlify configuration. TYPE: SimlifyConfig