COMPS.Data package

Subpackages

• COMPS.Data.WorkItems package
  • Submodules
    • COMPS.Data.WorkItems.BuilderWorkItem module
      • BuilderWorkItem

Submodules

• COMPS.Data.AssetCollection module
  • AssetCollection
    • AssetCollection.id
    • AssetCollection.date_created
    • AssetCollection.tags
    • AssetCollection.assets
    • AssetCollection.get()
    • AssetCollection.refresh()
    • AssetCollection.save()
    • AssetCollection.add_asset()
    • AssetCollection.retrieve_as_zip()
    • AssetCollection.static_retrieve_as_zip()
• COMPS.Data.AssetCollectionFile module
  • AssetCollectionFile
    • AssetCollectionFile.relative_path
    • AssetCollectionFile.tags
• COMPS.Data.AssetFile module
  • get_media_type_from_filename()
  • AssetFile
    • AssetFile.file_name
    • AssetFile.md5_checksum
    • AssetFile.length
    • AssetFile.uri
    • AssetFile.retrieve()
• COMPS.Data.AssetManager module
  • retrieve_asset_files()
  • retrieve_output_file_info()
  • retrieve_output_files_from_info()
  • retrieve_partial_output_file_from_info()
  • upload_large_asset()
  • EntityType
    • EntityType.Simulations
    • EntityType.WorkItems
• COMPS.Data.AssetType module
  • AssetType
    • AssetType.Linked
    • AssetType.Output
• COMPS.Data.BaseEntity module
  • EntityType
    • EntityType.article
    • EntityType.has_state
    • EntityType.name
  • get_entity_type()
• COMPS.Data.CommissionableEntity module
  • CommissionableEntity
    • CommissionableEntity.commission()
    • CommissionableEntity.cancel()
    • CommissionableEntity.delete()
• COMPS.Data.Configuration module
  • Configuration
    • Configuration.environment_name
    • Configuration.simulation_input_args
    • Configuration.working_directory_root
    • Configuration.executable_path
    • Configuration.node_group_name
    • Configuration.maximum_number_of_retries
    • Configuration.priority
    • Configuration.min_cores
    • Configuration.max_cores
    • Configuration.exclusive
    • Configuration.asset_collection_id
• COMPS.Data.Experiment module
  • Experiment
    • Experiment.id
    • Experiment.suite_id
    • Experiment.name
    • Experiment.description
    • Experiment.owner
    • Experiment.date_created
    • Experiment.last_modified
    • Experiment.tags
    • Experiment.configuration
    • Experiment.get()
    • Experiment.refresh()
    • Experiment.get_simulations()
    • Experiment.save()
• COMPS.Data.HpcJob module
  • HpcJob
    • HpcJob.job_id
    • HpcJob.job_state
    • HpcJob.priority
    • HpcJob.working_directory
    • HpcJob.output_directory_size
    • HpcJob.submit_time
    • HpcJob.start_time
    • HpcJob.end_time
    • HpcJob.error_message
    • HpcJob.configuration
  • HpcState
    • HpcState.NotSet
    • HpcState.Configuring
    • HpcState.Submitted
    • HpcState.Validating
    • HpcState.ExternalValidation
    • HpcState.Queued
    • HpcState.Running
    • HpcState.Finishing
    • HpcState.Finished
    • HpcState.Failed
    • HpcState.Canceled
    • HpcState.Canceling
• COMPS.Data.OutputFileMetadata module
  • OutputFileMetadata
    • OutputFileMetadata.length
    • OutputFileMetadata.friendly_name
    • OutputFileMetadata.path_from_root
    • OutputFileMetadata.url
    • OutputFileMetadata.mime_type
• COMPS.Data.Priority module
  • Priority
    • Priority.Lowest
    • Priority.BelowNormal
    • Priority.Normal
    • Priority.AboveNormal
    • Priority.Highest
• COMPS.Data.QueryCriteria module
  • QueryCriteria
    • QueryCriteria.fields
    • QueryCriteria.children
    • QueryCriteria.filters
    • QueryCriteria.tag_filters
    • QueryCriteria.xparams
    • QueryCriteria.select()
    • QueryCriteria.select_children()
    • QueryCriteria.where()
    • QueryCriteria.where_tag()
    • QueryCriteria.orderby()
    • QueryCriteria.offset()
    • QueryCriteria.count()
    • QueryCriteria.add_extra_params()
    • QueryCriteria.to_param_dict()
• COMPS.Data.RelatableEntity module
  • RelatableEntity
    • RelatableEntity.get_parent_related_workitems()
• COMPS.Data.SerializableEntity module
  • convert_if_string()
  • json_entity()
  • json_entity_internal()
  • json_property()
  • json_property_internal
  • parse_ISO8601_date()
  • parse_namedtuple_from_dict()
  • SerializableEntity
    • SerializableEntity.py2rest()
    • SerializableEntity.rest2py()
    • SerializableEntity.convertToDict()
• COMPS.Data.Simulation module
  • Simulation
    • Simulation.id
    • Simulation.experiment_id
    • Simulation.name
    • Simulation.description
    • Simulation.owner
    • Simulation.date_created
    • Simulation.last_modified
    • Simulation.state
    • Simulation.error_message
    • Simulation.tags
    • Simulation.configuration
    • Simulation.files
    • Simulation.hpc_jobs
    • Simulation.get()
    • Simulation.refresh()
    • Simulation.save()
    • Simulation.get_save_semaphore()
    • Simulation.save_all()
    • Simulation.add_file()
    • Simulation.retrieve_output_files()
    • Simulation.retrieve_output_file_info()
    • Simulation.retrieve_output_files_from_info()
    • Simulation.static_retrieve_output_files()
  • SimulationState
    • SimulationState.Created
    • SimulationState.CommissionRequested
    • SimulationState.Provisioning
    • SimulationState.Commissioned
    • SimulationState.Running
    • SimulationState.Retry
    • SimulationState.Succeeded
    • SimulationState.Failed
    • SimulationState.CancelRequested
    • SimulationState.Canceled
• COMPS.Data.SimulationFile module
  • SimulationFile
    • SimulationFile.file_type
    • SimulationFile.description
• COMPS.Data.Suite module
  • Suite
    • Suite.id
    • Suite.name
    • Suite.description
    • Suite.owner
    • Suite.date_created
    • Suite.last_modified
    • Suite.tags
    • Suite.configuration
    • Suite.get()
    • Suite.refresh()
    • Suite.get_experiments()
    • Suite.save()
• COMPS.Data.TaggableEntity module
  • TaggableEntity
    • TaggableEntity.set_tags()
    • TaggableEntity.merge_tags()
    • TaggableEntity.delete_tags()
  • TagOperationMode
    • TagOperationMode.Merge
    • TagOperationMode.Replace
    • TagOperationMode.Delete
• COMPS.Data.WorkItem module
  • WorkItem
    • WorkItem.id
    • WorkItem.name
    • WorkItem.worker
    • WorkItem.environment_name
    • WorkItem.description
    • WorkItem.owner
    • WorkItem.date_created
    • WorkItem.last_modified
    • WorkItem.state
    • WorkItem.error_message
    • WorkItem.host_name
    • WorkItem.worker_instance_id
    • WorkItem.priority
    • WorkItem.working_directory
    • WorkItem.working_directory_size
    • WorkItem.asset_collection_id
    • WorkItem.tags
    • WorkItem.files
    • WorkItem.plugins
    • WorkItem.get()
    • WorkItem.refresh()
    • WorkItem.get_related_work_items()
    • WorkItem.get_related_suites()
    • WorkItem.get_related_experiments()
    • WorkItem.get_related_simulations()
    • WorkItem.get_related_asset_collections()
    • WorkItem.add_related_work_item()
    • WorkItem.add_related_suite()
    • WorkItem.add_related_experiment()
    • WorkItem.add_related_simulation()
    • WorkItem.add_related_asset_collection()
    • WorkItem.save()
    • WorkItem.get_save_semaphore()
    • WorkItem.save_all()
    • WorkItem.add_work_order()
    • WorkItem.add_file()
    • WorkItem.retrieve_output_files()
    • WorkItem.retrieve_output_file_info()
    • WorkItem.retrieve_output_files_from_info()
    • WorkItem.static_retrieve_output_files()
  • WorkerOrPluginKey
    • WorkerOrPluginKey.name
    • WorkerOrPluginKey.version
  • WorkItemState
    • WorkItemState.Created
    • WorkItemState.CommissionRequested
    • WorkItemState.Commissioned
    • WorkItemState.Validating
    • WorkItemState.Running
    • WorkItemState.Waiting
    • WorkItemState.ResumeRequested
    • WorkItemState.CancelRequested
    • WorkItemState.Canceled
    • WorkItemState.Resumed
    • WorkItemState.Canceling
    • WorkItemState.Succeeded
    • WorkItemState.Failed
  • RelationType
    • RelationType.DependsOn
    • RelationType.Created
• COMPS.Data.WorkItemFile module
  • WorkItemFile
    • WorkItemFile.file_type
    • WorkItemFile.description