fireworks.scripts package — FireWorks 2.0.4 documentation

# fireworks.scripts package

## Subpackages

- fireworks.scripts.tests package
  - Submodules
  - fireworks.scripts.tests.test_lpad_run module
    - `lp()`
    - `test_lpad_config_file_flags()`
    - `test_lpad_get_fws()`
    - `test_lpad_report_version()`
  - fireworks.scripts.tests.test_mlaunch_run module
    - `test_mlaunch_config_file_flags()`
    - `test_mlaunch_report_version()`
  - fireworks.scripts.tests.test_qlaunch_run module
    - `test_qlaunch_config_file_flags()`
    - `test_qlaunch_report_version()`
  - fireworks.scripts.tests.test_rlaunch_run module
    - `test_rlaunch_config_file_flags()`
    - `test_rlaunch_report_version()`
  - 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: Namespace) → None

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

fireworks.scripts.lpad_run.get_fw_ids_helper(lp: LaunchPad, args: Namespace, count_only: bool | None = None) → 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: Namespace) → None

fireworks.scripts.lpad_run.get_fws_helper(lp: LaunchPad, ids: list[int], args: Namespace) → list[int] | int | list[dict[str, 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: Namespace) → None

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

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

fireworks.scripts.lpad_run.get_output(args: Namespace, objs: list[Any]) → None

  Prints output on stdout.

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

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

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

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

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

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

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

fireworks.scripts.lpad_run.parse_helper(lp: LaunchPad, args: 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:

    - lp (LaunchPad) – The Launchpad instance.

    - args – Namespace of parsed CLI arguments.

    - wf_mode (bool) – If True, will query lp for Workflow instead of Firework 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: Namespace) → None

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

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

  Prints results of some FireWorks query to stdout.

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

## fireworks.scripts.mlaunch_run module

A runnable script to launch Job Packing (Multiple) Rockets.

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

  Launch multiple Rockets simultaneously.

  Parameters:

    argv – Command line arguments (optional, defaults to sys.argv)

  Returns:

    Exit code (0 for success)

  Return type:

    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) → None

fireworks.scripts.qlaunch_run.qlaunch(argv: Sequence[str] | None = 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) → None

  Handle interrupt signal and exit gracefully.

  Parameters:

    - signum – Signal number

    - _frame – Frame object (unused)

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

  Launch one or more Rockets.

  Parameters:

    argv – Command line arguments (optional, defaults to sys.argv)

  Returns:

    Exit code (0 for success)

  Return type:

    int

## Module contents