add descriptions to strategies

'scheme' root compiler name, not movescheme

Author: dwhswenson

paths_cli/compiling/root_compiler.py

@@ -18,7 +18,7 @@ class CategoryCompilerRegistrationError(Exception):
     'volume',
     'state',
     'network',
-    'movescheme',
+    'scheme',
 ]
 
 COMPILE_ORDER = _DEFAULT_COMPILE_ORDER.copy()

paths_cli/compiling/strategies.py

@@ -48,6 +48,7 @@ def _group_parameter(group_name):
         REPLACE_TRUE_PARAMETER
     ],
     name='one-way-shooting',
+    description="Use one-way-shooting moves in this move scheme.",
 )
 build_one_way_shooting_strategy = ONE_WAY_SHOOTING_STRATEGY_PLUGIN
 
@@ -70,6 +71,8 @@ def _group_parameter(group_name):
         REPLACE_TRUE_PARAMETER
     ],
     name='nearest-neighbor-repex',
+    description=("Use replica exchange only between neearest-neighbor "
+                 "interfaces in this move scheme"),
 )
 
 build_all_set_repex_strategy = StrategyCompilerPlugin(
@@ -79,6 +82,8 @@ def _group_parameter(group_name):
         REPLACE_TRUE_PARAMETER
     ],
     name='all-set-repex',
+    description=("Use replica exchange allowing swap attempts between any "
+                 "pair of ensembles within the same interface set."),
 )
 
 build_path_reversal_strategy = StrategyCompilerPlugin(
@@ -88,6 +93,7 @@ def _group_parameter(group_name):
         REPLACE_TRUE_PARAMETER,
     ],
     name='path-reversal',
+    description="Use path reversal moves in this move scheme.",
 )
 
 build_minus_move_strategy = StrategyCompilerPlugin(
@@ -98,6 +104,9 @@ def _group_parameter(group_name):
         REPLACE_TRUE_PARAMETER,
     ],
     name='minus',
+    description=("Use the minus move in this move scheme. This strategy "
+                 "uses the M-shaped, or multiple interface set minus "
+                 "move, and always keeps a sample in the minus interface."),
 )
 
 build_single_replica_minus_move_strategy = StrategyCompilerPlugin(
@@ -108,6 +117,12 @@ def _group_parameter(group_name):
         REPLACE_TRUE_PARAMETER,
     ],
     name='single-replica-minus',
+    description=("Use the single-replica minus move in this move scheme. "
+                 "This strategy does not keep a replica in the minus "
+                 "ensemble; instead, that trajectory is only temporarily "
+                 "created during this move. This should not be used if "
+                 "there are multiple interface sets with the same initial "
+                 "state."),
 )
 
 STRATEGY_COMPILER = CategoryPlugin(StrategyCompilerPlugin,