fireworks.scripts package — FireWorks 2.0.2 documentation

# 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)

`fireworks.scripts.lpad_run.` `add_wf`(args)

`fireworks.scripts.lpad_run.` `add_wf_dir`(args)

`fireworks.scripts.lpad_run.` `append_wf`(args)

`fireworks.scripts.lpad_run.` `archive`(args)

`fireworks.scripts.lpad_run.` `arg_positive_int`(value)

`fireworks.scripts.lpad_run.` `cancel_qid`(args)

`fireworks.scripts.lpad_run.` `check_wf`(args)

`fireworks.scripts.lpad_run.` `defuse_fws`(args)

`fireworks.scripts.lpad_run.` `defuse_wfs`(args)

`fireworks.scripts.lpad_run.` `delete_wfs`(args)

`fireworks.scripts.lpad_run.` `detect_lostruns`(args)

`fireworks.scripts.lpad_run.` `detect_unreserved`(args)

`fireworks.scripts.lpad_run.` `dump_wf`(args)

`fireworks.scripts.lpad_run.` `forget_offline`(args)

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

`fireworks.scripts.lpad_run.` `get_fw_ids_helper`(lp, args, count_only=None)

  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

    [int]

`fireworks.scripts.lpad_run.` `get_fws`(args)

`fireworks.scripts.lpad_run.` `get_fws_helper`(lp, ids, args)

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

`fireworks.scripts.lpad_run.` `get_fws_in_wfs`(args)

`fireworks.scripts.lpad_run.` `get_launchdir`(args)

`fireworks.scripts.lpad_run.` `get_lp`(args)

`fireworks.scripts.lpad_run.` `get_output_func`(format)

`fireworks.scripts.lpad_run.` `get_qid`(args)

`fireworks.scripts.lpad_run.` `get_wfs`(args)

`fireworks.scripts.lpad_run.` `init_yaml`(args)

`fireworks.scripts.lpad_run.` `introspect`(args)

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

`fireworks.scripts.lpad_run.` `maintain`(args)

`fireworks.scripts.lpad_run.` `orphaned`(args)

`fireworks.scripts.lpad_run.` `parse_helper`(lp, args, wf_mode=False, skip_pw=False)

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

  Parameters

    - args –

    - wf_mode (bool) –

    - skip_pw (bool) –

  Returns

    list of ids

`fireworks.scripts.lpad_run.` `pause_fws`(args)

`fireworks.scripts.lpad_run.` `pause_wfs`(args)

`fireworks.scripts.lpad_run.` `print_fws`(ids, lp, args)

  Prints results of some FireWorks query to stdout.

`fireworks.scripts.lpad_run.` `pw_check`(ids, args, skip_pw=False)

`fireworks.scripts.lpad_run.` `recover_offline`(args)

`fireworks.scripts.lpad_run.` `refresh`(args)

`fireworks.scripts.lpad_run.` `reignite_fws`(args)

`fireworks.scripts.lpad_run.` `reignite_wfs`(args)

`fireworks.scripts.lpad_run.` `report`(args)

`fireworks.scripts.lpad_run.` `rerun_fws`(args)

`fireworks.scripts.lpad_run.` `reset`(args)

`fireworks.scripts.lpad_run.` `resume_fws`(args)

`fireworks.scripts.lpad_run.` `set_priority`(args)

`fireworks.scripts.lpad_run.` `track_fws`(args)

`fireworks.scripts.lpad_run.` `tuneup`(args)

`fireworks.scripts.lpad_run.` `unlock`(args)

`fireworks.scripts.lpad_run.` `update_fws`(args)

`fireworks.scripts.lpad_run.` `webgui`(args)

## 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