fireworks.user_objects package

Subpackages

• fireworks.user_objects.dupefinders package
  • Submodules
  • fireworks.user_objects.dupefinders.dupefinder_exact module
    • DupeFinderExact
      • DupeFinderExact.query()
  • Module contents
• fireworks.user_objects.firetasks package
  • Subpackages
    • fireworks.user_objects.firetasks.tests package
      • Submodules
      • fireworks.user_objects.firetasks.tests.test_dataflow_tasks module
      • fireworks.user_objects.firetasks.tests.test_fileio_tasks module
      • fireworks.user_objects.firetasks.tests.test_filepad_tasks module
      • fireworks.user_objects.firetasks.tests.test_script_task module
      • fireworks.user_objects.firetasks.tests.test_templatewriter_task module
      • Module contents
  • Submodules
  • fireworks.user_objects.firetasks.dataflow_tasks module
    • CommandLineTask
      • CommandLineTask.command_line_tool()
      • CommandLineTask.optional_params
      • CommandLineTask.required_params
      • CommandLineTask.run_task()
    • ForeachTask
      • ForeachTask.optional_params
      • ForeachTask.required_params
      • ForeachTask.run_task()
    • ImportDataTask
      • ImportDataTask.optional_params
      • ImportDataTask.required_params
      • ImportDataTask.run_task()
    • JoinDictTask
      • JoinDictTask.optional_params
      • JoinDictTask.required_params
      • JoinDictTask.run_task()
    • JoinListTask
      • JoinListTask.required_params
      • JoinListTask.run_task()
  • fireworks.user_objects.firetasks.fileio_tasks module
    • ArchiveDirTask
      • ArchiveDirTask.optional_params
      • ArchiveDirTask.required_params
      • ArchiveDirTask.run_task()
    • CompressDirTask
      • CompressDirTask.optional_params
      • CompressDirTask.run_task()
    • DecompressDirTask
      • DecompressDirTask.optional_params
      • DecompressDirTask.run_task()
    • FileDeleteTask
      • FileDeleteTask.optional_params
      • FileDeleteTask.required_params
      • FileDeleteTask.run_task()
    • FileTransferTask
      • FileTransferTask.fn_list
      • FileTransferTask.optional_params
      • FileTransferTask.required_params
      • FileTransferTask.run_task()
    • FileWriteTask
      • FileWriteTask.optional_params
      • FileWriteTask.required_params
      • FileWriteTask.run_task()
  • fireworks.user_objects.firetasks.filepad_tasks module
    • AddFilesTask
      • AddFilesTask.optional_params
      • AddFilesTask.required_params
      • AddFilesTask.run_task()
    • DeleteFilesTask
      • DeleteFilesTask.optional_params
      • DeleteFilesTask.required_params
      • DeleteFilesTask.run_task()
    • GetFilesByQueryTask
      • GetFilesByQueryTask.optional_params
      • GetFilesByQueryTask.required_params
      • GetFilesByQueryTask.run_task()
    • GetFilesTask
      • GetFilesTask.optional_params
      • GetFilesTask.required_params
      • GetFilesTask.run_task()
    • get_fpad()
  • fireworks.user_objects.firetasks.script_task module
    • PyTask
      • PyTask.other_params
      • PyTask.required_params
      • PyTask.run_task()
    • ScriptTask
      • ScriptTask.from_str()
      • ScriptTask.required_params
      • ScriptTask.run_task()
  • fireworks.user_objects.firetasks.templatewriter_task module
    • TemplateWriterTask
      • TemplateWriterTask.run_task()
  • fireworks.user_objects.firetasks.unittest_tasks module
    • ExportTestSerializer
      • ExportTestSerializer.__init__()
      • ExportTestSerializer.from_dict()
      • ExportTestSerializer.to_dict()
    • UnitTestSerializer
      • UnitTestSerializer.__init__()
      • UnitTestSerializer.from_dict()
      • UnitTestSerializer.to_dict()
  • Module contents
• fireworks.user_objects.queue_adapters package
  • Subpackages
    • fireworks.user_objects.queue_adapters.tests package
      • Submodules
      • fireworks.user_objects.queue_adapters.tests.test_common_adapter module
      • Module contents
  • Submodules
  • fireworks.user_objects.queue_adapters.common_adapter module
    • CommonAdapter
      • CommonAdapter.__init__()
      • CommonAdapter.default_q_commands
      • CommonAdapter.from_dict()
      • CommonAdapter.get_njobs_in_queue()
      • CommonAdapter.submit_to_queue()
      • CommonAdapter.to_dict()
  • fireworks.user_objects.queue_adapters.pbs_newt_adapter module
    • PBSAdapterNEWT
      • PBSAdapterNEWT.defaults
      • PBSAdapterNEWT.get_njobs_in_queue()
      • PBSAdapterNEWT.q_name
      • PBSAdapterNEWT.resource
      • PBSAdapterNEWT.submit_cmd
      • PBSAdapterNEWT.submit_to_queue()
      • PBSAdapterNEWT.template_file
  • Module contents

Module contents

User-facing objects: firetasks, dupefinders, and queue adapters.