Note: FireWorks is under active development; major features are yet to be implemented, and the internal code is refactored often and not suitable for production. However, certain components of the code are available for initial testing.
Warning
The latest version of FireWorks renames the lp_run.py, rlauncher.py, and qlauncher.py scripts. The .py extension has been removed and the names shortened as requested by some users. If you are upgrading from an old installation, you should delete the old scripts (e.g., by typing which lp_run.py and deleting it from that location). If you have set up queueparams, you will also want to update the script specified in the exe section to read rlaunch instead of rlauncher_run.py. If you encounter problems with your configuration, please contact the developer.
Warning
The syntax for the QueueLauncher has changed recently, i.e. you no longer need to specify my_queueparams.yaml if you specify a config dir.
FireWorks is a code for defining, managing, and executing scientific workflows. It can be used to automate most types of calculations over arbitrary computing resources, including those that have a queueing system.
FireWorks is intended to be a friendly workflow software that is easy to get started with, but flexible enough to handle complicated use cases.
Some (but not all) of its features include:
Some limitations of FireWorks include:
If you encounter any problems while using FireWorks, please let us know (see Contributing / Contact / Bug Reports).
It can be time-consuming to evaluate whether a workflow software will meet your computing needs from documentation alone. If you just want to know whether FireWorks is a potential solution to your workflow problem, one option is to e-mail a description of your problem to the developer at:
We can tell you if:
To get started with FireWorks, we suggest that you follow our core tutorials. These tutorials will set up a central server as well as worker computers. They will also demonstrate how to define and run basic workflows. We expect that completing all of the core tutorials will take between one and three hours. (You might want to get a snack...)
To get things running on a shared resource with a queueing system (e.g., a supercomputing center), you should complete the following tutorials:
We recommend that all users read (or at least browse) the following tutorials before using FireWorks seriously:
Python users and Power users will be interested in the following:
Planned future tutorials:
Want to see something added or changed? There are many ways to make that a reality! Some ways to get involved are:
The collaborative way to submit questions, issues / bug reports, and all other communication is through the FireWorks Github page. You can also contact:
The list of contributors to FireWorks can be found here.
Some comprehensive documentation is listed below (only for the brave!)