TODO: add docs
A FireWork defines a workflow step.
An FWorkflow connects FireWorks by their fw_ids.
A Launch is a describes a FireWork’s run on a computing resource. The same Launch might apply to multiple FireWorks, e.g. if they are identical.
A FWAction encapsulates the output of that launch.
Bases: fireworks.utilities.fw_serializers.FWSerializable
This is a ‘minimal’ or ‘compact’ dict representation of the FireWork
A set of global constants for FireWorks (Python code as a config file)
This module contains classes relevant for a FireWorker (worker computing resource)
Bases: fireworks.utilities.fw_serializers.FWSerializable
Bases: fireworks.utilities.fw_serializers.FWSerializable
The QueueAdapter is responsible for all interactions with a specific queue management system. This includes handling all details of queue script format as well as queue submission and management.
A user should extend this class with implementations that work on specific queue systems.
returns the number of jobs in the queue, probably using subprocess or shutil to call a command like ‘qstat’. returns None when the number of jobs cannot be determined.
Parameters: |
|
---|
returns a (multi-line) String representing the queue script, e.g. PBS script. All details of the queue script must be specified in the RocketParams().
Parameters: |
|
---|
submits the job to the queue, probably using subprocess or shutil :param rocket_params: A RocketParams() instance :param script_file: name of the script file to use (String)
Bases: fireworks.utilities.fw_serializers.FWSerializable
A RocketParams instance contains all the information needed to write a queue file and submit to a queue system. Details of the queue file format and queue submission commands should be included in the QueueAdapterBase object. Specific parameters used by the QueueAdapterBase should be included in the params variable.
Note: The QueueAdapter is loaded based on its fw_name alone See the docs for to_dict() for more details
Note: the QueueAdapter is being serialized using the FW name alone This keeps the serialization compact and easy to edit by humans. The from_dict() will dynamically find the correct QueueAdapter using its fw_name.
The LaunchPad manages the FireWorks database.
Bases: fireworks.utilities.fw_serializers.FWSerializable
The LaunchPad manages the FireWorks database.
Parameters: | wf – a Workflow object. |
---|
Given a FireWork id, give back a FireWork object
Parameters: | fw_id – FireWork id (int) |
---|---|
Returns: | FireWork object |
Return all the fw ids that match a query, :param query: a dict representing a Mongo query
Given a Launch id, return details of the Launch
Parameters: | launch_id – launch id |
---|---|
Returns: | Launch object |
Checkout the next FireWork id
Checkout the next Launch id
Given a FireWork id, give back the Workflow containing that FireWork :param fw_id: :return: A Workflow object
Create a new FireWorks database. This will overwrite the existing FireWorks database! To safeguard against accidentally erasing an existing database, a password must be entered.
Parameters: |
|
---|
Checks to see if the database contains any FireWorks that are ready to run :return: (T/F)
Note: usernames/passwords are exported as unencrypted Strings!
This module is used to submit jobs to a queue on a cluster. It can submit a single job, or if used in “rapid-fire” mode, can submit multiple jobs within a directory structure. The details of job submission and queue communication are handled using RocketParams, which specifies a QueueAdapter as well as desired properties of the submit script.
Submit a single job to the queue.
Parameters: |
|
---|
Submit many jobs to the queue.
Parameters: |
|
---|
TODO: add docs
Run a single rocket in the current directory :param launchpad: a LaunchPad object :param fworker: a FWorker object
Keeps running Rockets in m_dir until we reach an error. Automatically creates subdirectories for each Rocket. Usually stops when we run out of FireWorks from the LaunchPad.
Parameters: |
|
---|
Bases: fireworks.utilities.fw_serializers.FWSerializable
Bases: dict, fireworks.utilities.fw_serializers.FWSerializable