PR edits

sup3r/bias/bias_calc_cli.py

@@ -10,7 +10,7 @@
 
 import sup3r.bias.bias_calc
 from sup3r.utilities import ModuleName
-from sup3r.utilities.cli import BaseCLI
+from sup3r.utilities.cli import AVAILABLE_HARDWARE_OPTIONS, BaseCLI
 from sup3r.version import __version__
 
 logger = logging.getLogger(__name__)
@@ -62,7 +62,7 @@ def from_config(ctx, config_file, verbose=False, **__):
  cmd_log = '\n\t'.join(cmd.split('\n'))
  logger.debug(f'Running command:\n\t{cmd_log}')
 
- if hardware_option.lower() in ('kestrel', 'eagle', 'slurm'):
+ if hardware_option.lower() in AVAILABLE_HARDWARE_OPTIONS:
  kickoff_slurm_job(ctx, cmd, **exec_kwargs)
  else:
  kickoff_local_job(ctx, cmd)

sup3r/cli.py

@@ -116,18 +116,15 @@ def forward_pass(ctx, verbose):
  },
  },
  "execution_control": {
- "option": "local"
- },
- "execution_control_kestrel": {
  "option": "kestrel",
  "walltime": 4,
  "alloc": "sup3r"
  }
  }
 
- Note that the ``execution_control`` block will run the job locally,
- while the ``execution_control_kestrel`` block are kwargs that would
+ Note that the ``execution_control`` block contains kwargs that would
  be required to distribute the job on multiple nodes on the NREL HPC.
+ To run the job locally, use ``execution_control: {"option": "local"}``.
  """
  config_file = ctx.obj['CONFIG_FILE']
  verbose = any([verbose, ctx.obj['VERBOSE']])
@@ -165,18 +162,15 @@ def solar(ctx, verbose):
  "fp_pattern": "./chunks/sup3r*.h5",
  "nsrdb_fp": "/datasets/NSRDB/current/nsrdb_2015.h5",
  "execution_control": {
- "option": "local"
- },
- "execution_control_kestrel": {
  "option": "kestrel",
  "walltime": 4,
  "alloc": "sup3r"
  }
  }
 
- Note that the ``execution_control`` block will run the job locally,
- while the ``execution_control_kestrel`` block are kwargs that would
+ Note that the ``execution_control`` block contains kwargs that would
  be required to distribute the job on multiple nodes on the NREL HPC.
+ To run the job locally, use ``execution_control: {"option": "local"}``.
  """
  config_file = ctx.obj['CONFIG_FILE']
  verbose = any([verbose, ctx.obj['VERBOSE']])
@@ -229,18 +223,15 @@ def bias_calc(ctx, verbose):
  }
  ],
  "execution_control": {
- "option": "local"
- },
- "execution_control_kestrel": {
  "option": "kestrel",
  "walltime": 4,
  "alloc": "sup3r"
  }
  }
 
- Note that the ``execution_control`` block will run the job locally,
- while the ``execution_control_kestrel`` block are kwargs that would
+ Note that the ``execution_control`` block contains kwargs that would
  be required to distribute the job on multiple nodes on the NREL HPC.
+ To run the job locally, use ``execution_control: {"option": "local"}``.
  """
  config_file = ctx.obj['CONFIG_FILE']
  verbose = any([verbose, ctx.obj['VERBOSE']])

sup3r/pipeline/forward_pass_cli.py

@@ -11,7 +11,7 @@
 from sup3r.utilities import ModuleName
 from sup3r.version import __version__
 from sup3r.pipeline.forward_pass import ForwardPassStrategy, ForwardPass
-from sup3r.utilities.cli import BaseCLI
+from sup3r.utilities.cli import AVAILABLE_HARDWARE_OPTIONS, BaseCLI
 
 
 logger = logging.getLogger(__name__)
@@ -71,7 +71,7 @@ def from_config(ctx, config_file, verbose=False, **__):
  cmd_log = '\n\t'.join(cmd.split('\n'))
  logger.debug(f'Running command:\n\t{cmd_log}')
 
- if hardware_option.lower() in ('kestrel', 'eagle', 'slurm'):
+ if hardware_option.lower() in AVAILABLE_HARDWARE_OPTIONS:
  kickoff_slurm_job(ctx, cmd, **exec_kwargs)
  else:
  kickoff_local_job(ctx, cmd)

sup3r/postprocessing/data_collect_cli.py

@@ -9,7 +9,7 @@
 from sup3r.utilities import ModuleName
 from sup3r.version import __version__
 from sup3r.postprocessing.collection import Collector
-from sup3r.utilities.cli import BaseCLI
+from sup3r.utilities.cli import AVAILABLE_HARDWARE_OPTIONS, BaseCLI
 
 
 logger = logging.getLogger(__name__)
@@ -67,7 +67,7 @@ def from_config(ctx, config_file, verbose=False, **__):
  cmd_log = '\n\t'.join(cmd.split('\n'))
  logger.debug(f'Running command:\n\t{cmd_log}')
 
- if hardware_option.lower() in ('kestrel', 'eagle', 'slurm'):
+ if hardware_option.lower() in AVAILABLE_HARDWARE_OPTIONS:
  kickoff_slurm_job(ctx, cmd, **exec_kwargs)
  else:
  kickoff_local_job(ctx, cmd)

sup3r/preprocessing/data_extract_cli.py

@@ -8,7 +8,7 @@
 import sup3r
 from sup3r.utilities import ModuleName
 from sup3r.version import __version__
-from sup3r.utilities.cli import BaseCLI
+from sup3r.utilities.cli import AVAILABLE_HARDWARE_OPTIONS, BaseCLI
 
 
 logger = logging.getLogger(__name__)
@@ -57,7 +57,7 @@ def from_config(ctx, config_file, verbose=False, **__):
  cmd_log = '\n\t'.join(cmd.split('\n'))
  logger.debug(f'Running command:\n\t{cmd_log}')
 
- if hardware_option.lower() in ('kestrel', 'eagle', 'slurm'):
+ if hardware_option.lower() in AVAILABLE_HARDWARE_OPTIONS:
  kickoff_slurm_job(ctx, cmd, **exec_kwargs)
  else:
  kickoff_local_job(ctx, cmd)

sup3r/solar/solar_cli.py

@@ -10,7 +10,7 @@
 from sup3r.solar import Solar
 from sup3r.utilities import ModuleName
 from sup3r.version import __version__
-from sup3r.utilities.cli import BaseCLI
+from sup3r.utilities.cli import AVAILABLE_HARDWARE_OPTIONS, BaseCLI
 
 
 logger = logging.getLogger(__name__)
@@ -63,7 +63,7 @@ def from_config(ctx, config_file, verbose=False, **__):
  cmd_log = '\n\t'.join(cmd.split('\n'))
  logger.debug(f'Running command:\n\t{cmd_log}')
 
- if hardware_option.lower() in ('kestrel', 'eagle', 'slurm'):
+ if hardware_option.lower() in AVAILABLE_HARDWARE_OPTIONS:
  kickoff_slurm_job(ctx, cmd, **exec_kwargs)
  else:
  kickoff_local_job(ctx, cmd)

sup3r/utilities/cli.py

@@ -16,7 +16,9 @@
 
 from sup3r.utilities import ModuleName
 
+
 logger = logging.getLogger(__name__)
+AVAILABLE_HARDWARE_OPTIONS = ('kestrel', 'eagle', 'slurm')
 
 
 class SlurmManager(SLURM):
@@ -72,7 +74,7 @@ def from_config(cls, module_name, module_class, ctx, config_file, verbose):
  cmd_log = '\n\t'.join(cmd.split('\n'))
  logger.debug(f'Running command:\n\t{cmd_log}')
 
- if hardware_option.lower() in ('kestrel', 'eagle', 'slurm'):
+ if hardware_option.lower() in AVAILABLE_HARDWARE_OPTIONS:
  cls.kickoff_slurm_job(module_name, ctx, cmd, **exec_kwargs)
  else:
  cls.kickoff_local_job(module_name, ctx, cmd)

sup3r/utilities/regridder_cli.py

@@ -11,7 +11,7 @@
 from sup3r.utilities import ModuleName
 from sup3r.version import __version__
 from sup3r.utilities.regridder import RegridOutput
-from sup3r.utilities.cli import BaseCLI
+from sup3r.utilities.cli import AVAILABLE_HARDWARE_OPTIONS, BaseCLI
 
 
 logger = logging.getLogger(__name__)
@@ -71,7 +71,7 @@ def from_config(ctx, config_file, verbose=False, **__):
  cmd_log = '\n\t'.join(cmd.split('\n'))
  logger.debug(f'Running command:\n\t{cmd_log}')
 
- if hardware_option.lower() in ('kestrel', 'eagle', 'slurm'):
+ if hardware_option.lower() in AVAILABLE_HARDWARE_OPTIONS:
  kickoff_slurm_job(ctx, cmd, **exec_kwargs)
  else:
  kickoff_local_job(ctx, cmd)