fireworks.scripts package

Subpackages

• fireworks.scripts.tests package
  • Submodules
  • fireworks.scripts.tests.test_lpad_run module
  • fireworks.scripts.tests.test_mlaunch_run module
  • fireworks.scripts.tests.test_qlaunch_run module
  • fireworks.scripts.tests.test_rlaunch_run module
  • Module contents

Submodules

fireworks.scripts.lpad_run module

A runnable script for managing a FireWorks database (a command-line interface to launchpad.py)

fireworks.scripts.lpad_run.add_scripts(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.add_wf(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.add_wf_dir(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.append_wf(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.archive(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.arg_positive_int(value: str) → int

fireworks.scripts.lpad_run.cancel_qid(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.check_wf(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.defuse_fws(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.defuse_wfs(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.delete_wfs(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.detect_lostruns(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.detect_unreserved(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.dump_wf(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.forget_offline(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.get_children(links, start, max_depth)

fireworks.scripts.lpad_run.get_fw_ids_helper(lp: fireworks.core.launchpad.LaunchPad, args: argparse.Namespace, count_only: Optional[bool] = None) → Union[List[int], int]

Build fws query from command line options and submit.

Parameters

• lp (fireworks.core.firework.Launchpad) –

• args (argparse.Namespace) –

• count_only (bool) – if None, then looked up in args.

Returns

resulting fw_ids or count of fws in query.

Return type

list[int] | int

fireworks.scripts.lpad_run.get_fws(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.get_fws_helper(lp: fireworks.core.launchpad.LaunchPad, ids: List[int], args: argparse.Namespace) → Union[List[int], int, List[Dict[str, Union[str, int, bool]]], str, bool]

Get fws from ids in a representation according to args.display_format.

fireworks.scripts.lpad_run.get_fws_in_wfs(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.get_launchdir(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.get_lp(args: argparse.Namespace) → fireworks.core.launchpad.LaunchPad

fireworks.scripts.lpad_run.get_output_func(format: typing_extensions.Literal[json, yaml]) → Callable[[str], Any]

fireworks.scripts.lpad_run.get_qid(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.get_wfs(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.init_yaml(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.introspect(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.lpad(argv: Optional[Sequence[str]] = None) → int

fireworks.scripts.lpad_run.maintain(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.orphaned(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.parse_helper(lp: fireworks.core.launchpad.LaunchPad, args: argparse.Namespace, wf_mode: bool = False, skip_pw: bool = False) → List[int]

Helper method to parse args that can take either id, name, state or query.

Parameters

• args – Namespace of parsed CLI arguments.

• wf_mode (bool) – If True, will query lp for workflow instead of fireworks IDs.

• skip_pw (bool) – If True, skip PW check. Defaults to False.

Returns

Firework or Workflow IDs.

Return type

list[int]

fireworks.scripts.lpad_run.pause_fws(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.pause_wfs(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.print_fws(ids, lp, args: argparse.Namespace) → None

Prints results of some FireWorks query to stdout.

fireworks.scripts.lpad_run.pw_check(ids: List[int], args: argparse.Namespace, skip_pw: bool = False) → List[int]

fireworks.scripts.lpad_run.recover_offline(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.refresh(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.reignite_fws(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.reignite_wfs(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.report(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.rerun_fws(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.reset(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.resume_fws(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.set_priority(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.track_fws(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.tuneup(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.unlock(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.update_fws(args: argparse.Namespace) → None

fireworks.scripts.lpad_run.webgui(args: argparse.Namespace) → None

fireworks.scripts.mlaunch_run module

A runnable script to launch Job Packing (Multiple) Rockets

fireworks.scripts.mlaunch_run.mlaunch(argv: Optional[Sequence[str]] = None) → int

fireworks.scripts.qlaunch_run module

A runnable script for launching rockets (a command-line interface to queue_launcher.py)

fireworks.scripts.qlaunch_run.do_launch(args)

fireworks.scripts.qlaunch_run.qlaunch(argv: Optional[Sequence[str]] = None) → int

fireworks.scripts.rlaunch_run module

A runnable script to launch a single Rocket (a command-line interface to rocket_launcher.py)

fireworks.scripts.rlaunch_run.handle_interrupt(signum, frame)

fireworks.scripts.rlaunch_run.rlaunch(argv: Optional[Sequence[str]] = None) → int

Module contents