fireworks package

Subpackages

• fireworks.core package
  • Subpackages
    • fireworks.core.tests package
      • Submodules
      • fireworks.core.tests.tasks module
      • fireworks.core.tests.test_firework module
      • fireworks.core.tests.test_launchpad module
      • fireworks.core.tests.test_rocket module
      • fireworks.core.tests.test_tracker module
      • Module contents
  • Submodules
  • fireworks.core.firework module
    • FWAction
      • FWAction.__init__()
      • FWAction.from_dict()
      • FWAction.skip_remaining_tasks
      • FWAction.to_dict()
    • FireTaskBase
    • FiretaskBase
      • FiretaskBase.__init__()
      • FiretaskBase.from_dict()
      • FiretaskBase.optional_params
      • FiretaskBase.required_params
      • FiretaskBase.run_task()
      • FiretaskBase.to_dict()
    • Firework
      • Firework.STATE_RANKS
      • Firework.__init__()
      • Firework.from_dict()
      • Firework.state
      • Firework.to_db_dict()
      • Firework.to_dict()
    • Launch
      • Launch.__init__()
      • Launch.from_dict()
      • Launch.last_pinged
      • Launch.reservedtime_secs
      • Launch.runtime_secs
      • Launch.set_reservation_id()
      • Launch.state
      • Launch.time_end
      • Launch.time_reserved
      • Launch.time_start
      • Launch.to_db_dict()
      • Launch.to_dict()
      • Launch.touch_history()
    • Tracker
      • Tracker.MAX_TRACKER_LINES
      • Tracker.__init__()
      • Tracker.from_dict()
      • Tracker.to_dict()
      • Tracker.track_file()
    • Workflow
      • Workflow.Links
      • Workflow.__init__()
      • Workflow.append_wf()
      • Workflow.apply_action()
      • Workflow.from_dict()
      • Workflow.from_firework()
      • Workflow.from_wflow()
      • Workflow.fws
      • Workflow.leaf_fw_ids
      • Workflow.refresh()
      • Workflow.remove_fws()
      • Workflow.rerun_fw()
      • Workflow.reset()
      • Workflow.root_fw_ids
      • Workflow.state
      • Workflow.to_db_dict()
      • Workflow.to_dict()
      • Workflow.to_display_dict()
  • fireworks.core.fworker module
    • FWorker
      • FWorker.__init__()
      • FWorker.auto_load()
      • FWorker.from_dict()
      • FWorker.query
      • FWorker.to_dict()
  • fireworks.core.launchpad module
    • LaunchPad
      • LaunchPad.__init__()
      • LaunchPad.add_offline_run()
      • LaunchPad.add_wf()
      • LaunchPad.append_wf()
      • LaunchPad.archive_wf()
      • LaunchPad.auto_load()
      • LaunchPad.bulk_add_wfs()
      • LaunchPad.cancel_reservation()
      • LaunchPad.cancel_reservation_by_reservation_id()
      • LaunchPad.change_launch_dir()
      • LaunchPad.checkout_fw()
      • LaunchPad.complete_launch()
      • LaunchPad.defuse_fw()
      • LaunchPad.defuse_wf()
      • LaunchPad.delete_fws()
      • LaunchPad.delete_wf()
      • LaunchPad.detect_lostruns()
      • LaunchPad.detect_unreserved()
      • LaunchPad.forget_offline()
      • LaunchPad.from_dict()
      • LaunchPad.future_run_exists()
      • LaunchPad.get_fw_by_id()
      • LaunchPad.get_fw_dict_by_id()
      • LaunchPad.get_fw_ids()
      • LaunchPad.get_fw_ids_from_reservation_id()
      • LaunchPad.get_fw_ids_in_wfs()
      • LaunchPad.get_launch_by_id()
      • LaunchPad.get_launchdir()
      • LaunchPad.get_logdir()
      • LaunchPad.get_new_fw_id()
      • LaunchPad.get_new_launch_id()
      • LaunchPad.get_recovery()
      • LaunchPad.get_reservation_id_from_fw_id()
      • LaunchPad.get_tracker_data()
      • LaunchPad.get_wf_by_fw_id()
      • LaunchPad.get_wf_by_fw_id_lzyfw()
      • LaunchPad.get_wf_ids()
      • LaunchPad.get_wf_summary_dict()
      • LaunchPad.log_message()
      • LaunchPad.maintain()
      • LaunchPad.mark_fizzled()
      • LaunchPad.pause_fw()
      • LaunchPad.pause_wf()
      • LaunchPad.ping_launch()
      • LaunchPad.recover_offline()
      • LaunchPad.reignite_fw()
      • LaunchPad.reignite_wf()
      • LaunchPad.rerun_fw()
      • LaunchPad.reserve_fw()
      • LaunchPad.reset()
      • LaunchPad.restore_backup_data()
      • LaunchPad.resume_fw()
      • LaunchPad.run_exists()
      • LaunchPad.set_priority()
      • LaunchPad.set_reservation_id()
      • LaunchPad.to_dict()
      • LaunchPad.tuneup()
      • LaunchPad.update_spec()
    • LazyFirework
      • LazyFirework.__init__()
      • LazyFirework.archived_launches
      • LazyFirework.created_on
      • LazyFirework.db_fields
      • LazyFirework.db_launch_fields
      • LazyFirework.full_fw
      • LazyFirework.launches
      • LazyFirework.name
      • LazyFirework.parents
      • LazyFirework.partial_fw
      • LazyFirework.spec
      • LazyFirework.state
      • LazyFirework.tasks
      • LazyFirework.to_db_dict()
      • LazyFirework.to_dict()
      • LazyFirework.updated_on
    • LockedWorkflowError
    • WFLock
      • WFLock.__init__()
    • get_action_from_gridfs()
    • sort_aggregation()
  • fireworks.core.rocket module
    • Rocket
      • Rocket.__init__()
      • Rocket.decorate_fwaction()
      • Rocket.run()
      • Rocket.update_checkpoint()
    • background_task()
    • do_ping()
    • ping_launch()
    • start_background_task()
    • start_ping_launch()
    • stop_backgrounds()
  • fireworks.core.rocket_launcher module
    • get_fworker()
    • launch_rocket()
    • rapidfire()
  • Module contents
• fireworks.examples package
  • Subpackages
    • fireworks.examples.custom_firetasks package
      • Subpackages
      • Module contents
    • fireworks.examples.tutorial_examples package
      • Submodules
      • fireworks.examples.tutorial_examples.dynamic_wf1 module
      • fireworks.examples.tutorial_examples.dynamic_wf2 module
      • fireworks.examples.tutorial_examples.firetasks module
      • fireworks.examples.tutorial_examples.introduction module
      • fireworks.examples.tutorial_examples.workflows module
      • Module contents
  • Module contents
• fireworks.features package
  • Subpackages
    • fireworks.features.tests package
      • Submodules
      • fireworks.features.tests.test_introspect module
      • Module contents
  • Submodules
  • fireworks.features.background_task module
    • BackgroundTask
      • BackgroundTask.__init__()
      • BackgroundTask.from_dict()
      • BackgroundTask.to_dict()
  • fireworks.features.dupefinder module
    • DupeFinderBase
      • DupeFinderBase.__init__()
      • DupeFinderBase.from_dict()
      • DupeFinderBase.query()
      • DupeFinderBase.to_dict()
      • DupeFinderBase.verify()
  • fireworks.features.fw_report module
    • FWReport
      • FWReport.__init__()
      • FWReport.get_stats()
      • FWReport.get_stats_str()
      • FWReport.plot_stats()
  • fireworks.features.introspect module
    • Introspector
      • Introspector.__init__()
      • Introspector.introspect_fizzled()
      • Introspector.print_report()
    • collect_stats()
    • compare_stats()
    • flatten_to_keys()
  • fireworks.features.multi_launcher module
    • launch_multiprocess()
    • ping_multilaunch()
    • rapidfire_process()
    • split_node_lists()
    • start_rockets()
  • fireworks.features.stats module
    • FWStats
      • FWStats.__init__()
      • FWStats.get_daily_completion_summary()
      • FWStats.get_fireworks_summary()
      • FWStats.get_launch_summary()
      • FWStats.get_workflow_summary()
      • FWStats.group_fizzled_fireworks()
      • FWStats.identify_catastrophes()
  • Module contents
• fireworks.flask_site package
  • Submodules
  • fireworks.flask_site.app module
    • authenticate()
    • check_auth()
    • dashboard()
    • datetime()
    • fw_details()
    • fw_state()
    • get_fw_details()
    • home()
    • parse_querystr()
    • pluralize()
    • report()
    • requires_auth()
    • simple()
    • wf_details()
    • wf_metadata_find()
    • wf_state()
    • workflow_json()
  • fireworks.flask_site.gunicorn module
    • StandaloneApplication
      • StandaloneApplication.__init__()
      • StandaloneApplication.load()
      • StandaloneApplication.load_config()
  • fireworks.flask_site.helpers module
    • fw_filt_given_wf_filt()
    • get_totals()
    • uses_index()
    • wf_filt_given_fw_filt()
  • fireworks.flask_site.util module
    • MongoJsonEncoder
      • MongoJsonEncoder.default()
    • jsonify()
  • Module contents
• fireworks.queue package
  • Submodules
  • fireworks.queue.queue_adapter module
    • Command
      • Command.__init__()
      • Command.command
      • Command.error
      • Command.output
      • Command.process
      • Command.run()
      • Command.status
    • QScriptTemplate
      • QScriptTemplate.delimiter
      • QScriptTemplate.pattern
    • QueueAdapterBase
      • QueueAdapterBase.defaults
      • QueueAdapterBase.from_dict()
      • QueueAdapterBase.get_njobs_in_queue()
      • QueueAdapterBase.get_qlogger()
      • QueueAdapterBase.get_script_str()
      • QueueAdapterBase.q_name
      • QueueAdapterBase.submit_cmd
      • QueueAdapterBase.submit_to_queue()
      • QueueAdapterBase.template_file
      • QueueAdapterBase.to_dict()
  • fireworks.queue.queue_launcher module
    • launch_rocket_to_queue()
    • rapidfire()
    • setup_offline_job()
  • Module contents
• 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
    • add_scripts()
    • add_wf()
    • add_wf_dir()
    • append_wf()
    • archive()
    • arg_positive_int()
    • cancel_qid()
    • check_wf()
    • defuse_fws()
    • defuse_wfs()
    • delete_wfs()
    • detect_lostruns()
    • detect_unreserved()
    • dump_wf()
    • forget_offline()
    • get_children()
    • get_fw_ids_helper()
    • get_fws()
    • get_fws_helper()
    • get_fws_in_wfs()
    • get_launchdir()
    • get_lp()
    • get_output()
    • get_qid()
    • get_wfs()
    • init_yaml()
    • introspect()
    • lpad()
    • maintain()
    • orphaned()
    • parse_helper()
    • pause_fws()
    • pause_wfs()
    • print_fws()
    • pw_check()
    • recover_offline()
    • refresh()
    • reignite_fws()
    • reignite_wfs()
    • report()
    • rerun_fws()
    • reset()
    • resume_fws()
    • set_priority()
    • track_fws()
    • tuneup()
    • unlock()
    • update_fws()
    • webgui()
  • fireworks.scripts.mlaunch_run module
    • mlaunch()
  • fireworks.scripts.qlaunch_run module
    • do_launch()
    • qlaunch()
  • fireworks.scripts.rlaunch_run module
    • handle_interrupt()
    • rlaunch()
  • Module contents
• fireworks.tests package
  • Submodules
  • fireworks.tests.master_tests module
    • BasicTests
      • BasicTests.test_fwconnector()
      • BasicTests.test_parent_connector()
    • SerializationTests
      • SerializationTests.get_data()
      • SerializationTests.test_recursive_deserialize()
      • SerializationTests.test_serialization_details()
    • TestImports
      • TestImports.test_imports()
  • fireworks.tests.mongo_tests module
    • AppendWFActionTask
      • AppendWFActionTask.required_params
      • AppendWFActionTask.run_task()
    • ModSpecTask
      • ModSpecTask.run_task()
    • MongoTests
      • MongoTests.setUp()
      • MongoTests.setUpClass()
      • MongoTests.tearDown()
      • MongoTests.tearDownClass()
      • MongoTests.test_add_fw()
      • MongoTests.test_add_lp_and_fw_id()
      • MongoTests.test_append_wf()
      • MongoTests.test_append_wf_detour()
      • MongoTests.test_append_wf_detour_two_parents()
      • MongoTests.test_append_wfs_action()
      • MongoTests.test_archive()
      • MongoTests.test_backgroundtask()
      • MongoTests.test_basic_fw()
      • MongoTests.test_basic_fw_offline()
      • MongoTests.test_category()
      • MongoTests.test_category_pt2()
      • MongoTests.test_defuse()
      • MongoTests.test_delete_fw()
      • MongoTests.test_dupefinder()
      • MongoTests.test_duplicate_delete_fw()
      • MongoTests.test_fibadder()
      • MongoTests.test_files_in_out()
      • MongoTests.test_fizzle()
      • MongoTests.test_force_lock_removal()
      • MongoTests.test_fw_env()
      • MongoTests.test_job_info()
      • MongoTests.test_multi_detour()
      • MongoTests.test_multi_fw()
      • MongoTests.test_multi_fw_complex()
      • MongoTests.test_offline_fw_passinfo()
      • MongoTests.test_org_wf()
      • MongoTests.test_parallel_fibadder()
      • MongoTests.test_preserve_fworker()
      • MongoTests.test_spec_copy()
      • MongoTests.test_stats()
    • MultipleDetourTask
      • MultipleDetourTask.run_task()
    • SummationTask
      • SummationTask.required_params
      • SummationTask.run_task()
    • UpdateSpecTask
      • UpdateSpecTask.run_task()
    • random_launch()
    • throw_error()
  • fireworks.tests.multiprocessing_tests module
    • TestCheckoutFW
      • TestCheckoutFW.lp
      • TestCheckoutFW.setUp()
      • TestCheckoutFW.setUpClass()
      • TestCheckoutFW.tearDown()
      • TestCheckoutFW.tearDownClass()
      • TestCheckoutFW.test_checkout_fw()
    • TestEarlyExit
      • TestEarlyExit.lp
      • TestEarlyExit.setUp()
      • TestEarlyExit.setUpClass()
      • TestEarlyExit.tearDown()
      • TestEarlyExit.tearDownClass()
      • TestEarlyExit.test_early_exit()
    • TestLinks
      • TestLinks.test_pickle()
  • fireworks.tests.tasks module
    • DummyFWEnvTask
      • DummyFWEnvTask.run_task()
    • DummyJobPassTask
      • DummyJobPassTask.run_task()
    • DummyLPTask
      • DummyLPTask.run_task()
  • fireworks.tests.test_deserialization module
    • FakeBadTask
      • FakeBadTask.to_dict()
    • lpad()
    • test_fizzle_on_deserialization_failure()
    • test_queue_skips_bad_and_runs_next()
    • test_workflow_state_updated_on_deserialization_failure()
  • fireworks.tests.test_fw_config module
    • ConfigTest
      • ConfigTest.test_config()
    • FWConfigTest
      • FWConfigTest.setUp()
      • FWConfigTest.tearDown()
      • FWConfigTest.test_override_user_settings_empty_yaml()
      • FWConfigTest.test_override_user_settings_invalid_key()
  • fireworks.tests.test_workflow module
    • TestWorkflowState
      • TestWorkflowState.test_archived()
      • TestWorkflowState.test_completed()
      • TestWorkflowState.test_defused()
      • TestWorkflowState.test_fizzled_1()
      • TestWorkflowState.test_fizzled_2()
      • TestWorkflowState.test_fizzled_3()
      • TestWorkflowState.test_fizzled_4()
      • TestWorkflowState.test_fizzled_5()
      • TestWorkflowState.test_fizzled_6()
      • TestWorkflowState.test_paused()
      • TestWorkflowState.test_ready()
      • TestWorkflowState.test_reserved()
      • TestWorkflowState.test_running_1()
      • TestWorkflowState.test_running_2()
  • Module contents
• fireworks.user_objects package
  • Subpackages
    • fireworks.user_objects.dupefinders package
      • Submodules
      • fireworks.user_objects.dupefinders.dupefinder_exact module
      • Module contents
    • fireworks.user_objects.firetasks package
      • Subpackages
      • Submodules
      • fireworks.user_objects.firetasks.dataflow_tasks module
      • fireworks.user_objects.firetasks.fileio_tasks module
      • fireworks.user_objects.firetasks.filepad_tasks module
      • fireworks.user_objects.firetasks.script_task module
      • fireworks.user_objects.firetasks.templatewriter_task module
      • fireworks.user_objects.firetasks.unittest_tasks module
      • Module contents
    • fireworks.user_objects.queue_adapters package
      • Subpackages
      • Submodules
      • fireworks.user_objects.queue_adapters.common_adapter module
      • fireworks.user_objects.queue_adapters.pbs_newt_adapter module
      • Module contents
  • Module contents
• fireworks.utilities package
  • Subpackages
    • fireworks.utilities.tests package
      • Submodules
      • fireworks.utilities.tests.test_dagflow module
      • fireworks.utilities.tests.test_filepad module
      • fireworks.utilities.tests.test_fw_serializers module
      • fireworks.utilities.tests.test_update_collection module
      • fireworks.utilities.tests.test_visualize module
      • Module contents
  • Submodules
  • fireworks.utilities.dagflow module
  • fireworks.utilities.dict_mods module
    • apply_mod()
    • arrow_to_dot()
    • get_nested_dict()
  • fireworks.utilities.exceptions module
    • FWConfigurationError
    • FWError
    • FWFormatError
    • FWSerializationError
    • FWValueError
  • fireworks.utilities.filepad module
    • FilePad
      • FilePad.__init__()
      • FilePad.add_contents()
      • FilePad.add_file()
      • FilePad.auto_load()
      • FilePad.build_indexes()
      • FilePad.count()
      • FilePad.delete_file()
      • FilePad.delete_file_by_id()
      • FilePad.delete_file_by_query()
      • FilePad.from_db_file()
      • FilePad.get_file()
      • FilePad.get_file_by_id()
      • FilePad.get_file_by_query()
      • FilePad.reset()
      • FilePad.update_file()
      • FilePad.update_file_by_id()
  • fireworks.utilities.fw_serializers module
    • DATETIME_HANDLER()
    • FWSerializable
      • FWSerializable.as_dict()
      • FWSerializable.from_dict()
      • FWSerializable.from_file()
      • FWSerializable.from_format()
      • FWSerializable.fw_name
      • FWSerializable.to_db_dict()
      • FWSerializable.to_dict()
      • FWSerializable.to_file()
      • FWSerializable.to_format()
    • get_default_serialization()
    • load_object()
    • load_object_from_file()
    • reconstitute_dates()
    • recursive_deserialize()
    • recursive_dict()
    • recursive_serialize()
    • serialize_fw()
  • fireworks.utilities.fw_utilities module
    • DataServer
      • DataServer.register_launchpad()
      • DataServer.setup()
    • NestedClassGetter
    • create_datestamp_dir()
    • explicit_serialize()
    • get_fw_logger()
    • get_my_host()
    • get_my_ip()
    • get_slug()
    • log_exception()
    • log_fancy()
    • log_multi()
    • redirect_local()
  • fireworks.utilities.update_collection module
    • update_launchpad_data()
    • update_path_in_collection()
  • fireworks.utilities.visualize module
    • plot_wf()
    • wf_to_graph()
  • Module contents

Submodules

fireworks.fw_config module

A set of global constants for FireWorks (Python code as a config file).

fireworks.fw_config.config_to_dict() → dict[str, Any]

fireworks.fw_config.override_user_settings() → None

fireworks.fw_config.write_config(path: str | None = None) → None

Module contents