schrodinger.application.desmond.starter.ui.fep_solubility module¶
FEP+ solubility command line UI
Copyright Schrodinger, LLC. All rights reserved.
- class schrodinger.application.desmond.starter.ui.fep_solubility.FepSolubilityArgs(opt: argparse.Namespace)¶
Bases:
schrodinger.application.desmond.starter.ui.cmdline.FepArgs
- PROGRAM_NAME: str = 'FEP Solubility'¶
- SUPPORTED_FEP_TYPES: List[str] = ['solubility']¶
- copy_parser_attributes(opt: argparse.Namespace)¶
Copy parser options (e.g: time, buffer, …) from
opt
toself
. Subclass needs to call this method in __init__
- validate() List[str] ¶
Validate the parameters for FEP+ solubility command line UI
- Returns
a list of error messages for invalid parameters
- get_time_for_leg(leg_type: str) Optional[float] ¶
Get simulation time for FEP leg. Implemented in subclasses of FepArgs.
- __init__(opt: argparse.Namespace)¶
- Parameters
opt – Command line options with corresponding values.
- check_duplicate_titles(sts: List[schrodinger.structure._structure.Structure])¶
- check_ppj()¶
Raise a warning if restarting and trying to set ppj.
- Raises
UserWarning – If ppj set for a restarted job.
- generate_jobname()¶
If the JOBNAME was not set and this is a new job, automatically generate a job name.
- property mode: schrodinger.application.desmond.constants.UiMode¶
- set_mps_factor(val)¶
Set the mps oversubcription factor. If val is
auto
, the mps factor will be determined automatically. Otherwise it is set directly, and should have anint
value.0
is treated equivalently to the value1
.
- schrodinger.application.desmond.starter.ui.fep_solubility.ui(argv: List[str]) schrodinger.application.desmond.starter.ui.fep_solubility.FepSolubilityArgs ¶
Parse the arguments and return an object containing the values.
- Parameters
argv – List of command line arguments
- Returns
Parsed command line options