TODO: add docs
Bases: fireworks.utilities.fw_serializers.FWSerializable
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.
TODO: add docs
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
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!
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