pyCOMPS
v2.10.0
Overview of COMPS
Create simulations
Create climate input
Manage simulations
Architecture
COMPS package
Glossary
pyCOMPS
IDM docs
»
pyCOMPS
»
Index
Edit on GitHub
Index
A
|
B
|
C
|
D
|
E
|
F
|
G
|
H
|
I
|
J
|
L
|
M
|
N
|
O
|
P
|
Q
|
R
|
S
|
T
|
U
|
V
|
W
|
X
A
AboveNormal (COMPS.Data.Priority.Priority attribute)
add_asset() (COMPS.Data.AssetCollection.AssetCollection method)
add_extra_params() (COMPS.Data.QueryCriteria.QueryCriteria method)
add_file() (COMPS.Data.Simulation.Simulation method)
(COMPS.Data.WorkItem.WorkItem method)
add_related_asset_collection() (COMPS.Data.WorkItem.WorkItem method)
add_related_experiment() (COMPS.Data.WorkItem.WorkItem method)
add_related_simulation() (COMPS.Data.WorkItem.WorkItem method)
add_related_suite() (COMPS.Data.WorkItem.WorkItem method)
add_related_work_item() (COMPS.Data.WorkItem.WorkItem method)
add_work_order() (COMPS.Data.WorkItem.WorkItem method)
article() (COMPS.Data.BaseEntity.EntityType property)
asset collection
asset_collection_id() (COMPS.Data.Configuration.Configuration property)
(COMPS.Data.WorkItem.WorkItem property)
AssetCollection (class in COMPS.Data.AssetCollection)
AssetCollectionFile (class in COMPS.Data.AssetCollectionFile)
AssetFile (class in COMPS.Data.AssetFile)
assets() (COMPS.Data.AssetCollection.AssetCollection property)
AssetType (class in COMPS.Data.AssetType)
auth_manager() (COMPS.Client.Client class method)
AuthManager (class in COMPS.AuthManager)
B
BelowNormal (COMPS.Data.Priority.Priority attribute)
BuilderWorkItem (class in COMPS.Data.WorkItems.BuilderWorkItem)
C
cancel() (COMPS.Data.CommissionableEntity.CommissionableEntity method)
Canceled (COMPS.Data.HpcJob.HpcState attribute)
(COMPS.Data.Simulation.SimulationState attribute)
(COMPS.Data.WorkItem.WorkItemState attribute)
Canceling (COMPS.Data.HpcJob.HpcState attribute)
(COMPS.Data.WorkItem.WorkItemState attribute)
CancelRequested (COMPS.Data.Simulation.SimulationState attribute)
(COMPS.Data.WorkItem.WorkItemState attribute)
children() (COMPS.Data.QueryCriteria.QueryCriteria property)
clear_auth_token() (COMPS.AuthManager.AuthManager method)
Client (class in COMPS.Client)
clone_simulation() (in module COMPS.utils.clone_simulation)
commission() (COMPS.Data.CommissionableEntity.CommissionableEntity method)
CommissionableEntity (class in COMPS.Data.CommissionableEntity)
Commissioned (COMPS.Data.Simulation.SimulationState attribute)
(COMPS.Data.WorkItem.WorkItemState attribute)
CommissionRequested (COMPS.Data.Simulation.SimulationState attribute)
(COMPS.Data.WorkItem.WorkItemState attribute)
COMPS
module
COMPS.AuthManager
module
COMPS.Client
module
COMPS.CredentialPrompt
module
COMPS.Data
module
COMPS.Data.AssetCollection
module
COMPS.Data.AssetCollectionFile
module
COMPS.Data.AssetFile
module
COMPS.Data.AssetManager
module
COMPS.Data.AssetType
module
COMPS.Data.BaseEntity
module
COMPS.Data.CommissionableEntity
module
COMPS.Data.Configuration
module
COMPS.Data.Experiment
module
COMPS.Data.HpcJob
module
COMPS.Data.OutputFileMetadata
module
COMPS.Data.Priority
module
COMPS.Data.QueryCriteria
module
COMPS.Data.RelatableEntity
module
COMPS.Data.SerializableEntity
module
COMPS.Data.Simulation
module
COMPS.Data.SimulationFile
module
COMPS.Data.Suite
module
COMPS.Data.TaggableEntity
module
COMPS.Data.WorkItem
module
COMPS.Data.WorkItemFile
module
COMPS.Data.WorkItems
module
COMPS.Data.WorkItems.BuilderWorkItem
module
COMPS.utils
module
COMPS.utils.clone_simulation
module
COMPS.utils.create_asset_collection
module
COMPS.utils.get_output_files_for_experiment
module
COMPS.utils.get_output_files_for_workitem
module
COMPS.utils.get_output_tail
module
COMPS.utils.get_status
module
COMPS.utils.main
module
COMPS.utils.rerun_failed_simulations_for_experiment
module
Configuration (class in COMPS.Data.Configuration)
configuration() (COMPS.Data.Experiment.Experiment property)
(COMPS.Data.HpcJob.HpcJob property)
(COMPS.Data.Simulation.Simulation property)
(COMPS.Data.Suite.Suite property)
Configuring (COMPS.Data.HpcJob.HpcState attribute)
ConsoleCredentialPrompt (class in COMPS.CredentialPrompt)
convert_if_string() (in module COMPS.Data.SerializableEntity)
convertToDict() (COMPS.Data.SerializableEntity.SerializableEntity static method)
count() (COMPS.Data.QueryCriteria.QueryCriteria method)
create_asset_collection() (in module COMPS.utils.create_asset_collection)
Created (COMPS.Data.Simulation.SimulationState attribute)
(COMPS.Data.WorkItem.RelationType attribute)
(COMPS.Data.WorkItem.WorkItemState attribute)
CredentialPrompt (class in COMPS.CredentialPrompt)
CustomCommandFormatter (class in COMPS.utils.main)
CustomFormatter (class in COMPS.utils.main)
D
dashboard
date_created() (COMPS.Data.AssetCollection.AssetCollection property)
(COMPS.Data.Experiment.Experiment property)
(COMPS.Data.Simulation.Simulation property)
(COMPS.Data.Suite.Suite property)
(COMPS.Data.WorkItem.WorkItem property)
Delete (COMPS.Data.TaggableEntity.TagOperationMode attribute)
delete() (COMPS.Client.Client class method)
(COMPS.Data.CommissionableEntity.CommissionableEntity method)
delete_tags() (COMPS.Data.TaggableEntity.TaggableEntity method)
DependsOn (COMPS.Data.WorkItem.RelationType attribute)
description() (COMPS.Data.Experiment.Experiment property)
(COMPS.Data.Simulation.Simulation property)
(COMPS.Data.SimulationFile.SimulationFile property)
(COMPS.Data.Suite.Suite property)
(COMPS.Data.WorkItem.WorkItem property)
(COMPS.Data.WorkItemFile.WorkItemFile property)
E
end_time() (COMPS.Data.HpcJob.HpcJob property)
EntityType (class in COMPS.Data.AssetManager)
(class in COMPS.Data.BaseEntity)
environment_name() (COMPS.Data.Configuration.Configuration property)
(COMPS.Data.WorkItem.WorkItem property)
environments() (COMPS.AuthManager.AuthManager property)
error_message() (COMPS.Data.HpcJob.HpcJob property)
(COMPS.Data.Simulation.Simulation property)
(COMPS.Data.WorkItem.WorkItem property)
exclusive() (COMPS.Data.Configuration.Configuration property)
executable_path() (COMPS.Data.Configuration.Configuration property)
Experiment (class in COMPS.Data.Experiment)
experiment_id() (COMPS.Data.Simulation.Simulation property)
experiments
ExternalValidation (COMPS.Data.HpcJob.HpcState attribute)
F
Failed (COMPS.Data.HpcJob.HpcState attribute)
(COMPS.Data.Simulation.SimulationState attribute)
(COMPS.Data.WorkItem.WorkItemState attribute)
fields() (COMPS.Data.QueryCriteria.QueryCriteria property)
file_name() (COMPS.Data.AssetFile.AssetFile property)
file_type() (COMPS.Data.SimulationFile.SimulationFile property)
(COMPS.Data.WorkItemFile.WorkItemFile property)
files() (COMPS.Data.Simulation.Simulation property)
(COMPS.Data.WorkItem.WorkItem property)
fill_parser() (in module COMPS.utils.clone_simulation)
(in module COMPS.utils.create_asset_collection)
(in module COMPS.utils.get_output_files_for_experiment)
(in module COMPS.utils.get_output_files_for_workitem)
(in module COMPS.utils.get_output_tail)
(in module COMPS.utils.get_status)
(in module COMPS.utils.rerun_failed_simulations_for_experiment)
filters() (COMPS.Data.QueryCriteria.QueryCriteria property)
Finished (COMPS.Data.HpcJob.HpcState attribute)
Finishing (COMPS.Data.HpcJob.HpcState attribute)
friendly_name() (COMPS.Data.OutputFileMetadata.OutputFileMetadata property)
G
get() (COMPS.Client.Client class method)
(COMPS.Data.AssetCollection.AssetCollection class method)
(COMPS.Data.Experiment.Experiment class method)
(COMPS.Data.Simulation.Simulation class method)
(COMPS.Data.Suite.Suite class method)
(COMPS.Data.WorkItem.WorkItem class method)
get_auth_token() (COMPS.AuthManager.AuthManager method)
get_credential_prompt() (in module COMPS.CredentialPrompt)
get_entity_type() (in module COMPS.Data.BaseEntity)
get_environment_macros() (COMPS.AuthManager.AuthManager static method)
get_experiments() (COMPS.Data.Suite.Suite method)
get_files() (in module COMPS.utils.get_output_files_for_experiment)
(in module COMPS.utils.get_output_files_for_workitem)
get_group_name_for_environment() (COMPS.AuthManager.AuthManager static method)
get_media_type_from_filename() (in module COMPS.Data.AssetFile)
get_parent_related_workitems() (COMPS.Data.RelatableEntity.RelatableEntity method)
get_related_asset_collections() (COMPS.Data.WorkItem.WorkItem method)
get_related_experiments() (COMPS.Data.WorkItem.WorkItem method)
get_related_simulations() (COMPS.Data.WorkItem.WorkItem method)
get_related_suites() (COMPS.Data.WorkItem.WorkItem method)
get_related_work_items() (COMPS.Data.WorkItem.WorkItem method)
get_save_semaphore() (COMPS.Data.Simulation.Simulation class method)
(COMPS.Data.WorkItem.WorkItem class method)
get_simulations() (COMPS.Data.Experiment.Experiment method)
get_status() (in module COMPS.utils.get_status)
get_tail() (in module COMPS.utils.get_output_tail)
groups() (COMPS.AuthManager.AuthManager property)
H
has_auth_token() (COMPS.AuthManager.AuthManager method)
has_state() (COMPS.Data.BaseEntity.EntityType property)
Highest (COMPS.Data.Priority.Priority attribute)
host_name() (COMPS.Data.WorkItem.WorkItem property)
hoststring() (COMPS.AuthManager.AuthManager property)
hpc_jobs() (COMPS.Data.Simulation.Simulation property)
HpcJob (class in COMPS.Data.HpcJob)
HpcState (class in COMPS.Data.HpcJob)
I
id() (COMPS.Data.AssetCollection.AssetCollection property)
(COMPS.Data.Experiment.Experiment property)
(COMPS.Data.Simulation.Simulation property)
(COMPS.Data.Suite.Suite property)
(COMPS.Data.WorkItem.WorkItem property)
is_failed_sim_simple() (in module COMPS.utils.rerun_failed_simulations_for_experiment)
J
job_id() (COMPS.Data.HpcJob.HpcJob property)
job_state() (COMPS.Data.HpcJob.HpcJob property)
json_entity() (in module COMPS.Data.SerializableEntity)
json_entity_internal() (in module COMPS.Data.SerializableEntity)
json_property() (in module COMPS.Data.SerializableEntity)
json_property_internal (class in COMPS.Data.SerializableEntity)
L
last_modified() (COMPS.Data.Experiment.Experiment property)
(COMPS.Data.Simulation.Simulation property)
(COMPS.Data.Suite.Suite property)
(COMPS.Data.WorkItem.WorkItem property)
length() (COMPS.Data.AssetFile.AssetFile property)
(COMPS.Data.OutputFileMetadata.OutputFileMetadata property)
Linked (COMPS.Data.AssetType.AssetType attribute)
login() (COMPS.Client.Client class method)
logout() (COMPS.Client.Client class method)
Lowest (COMPS.Data.Priority.Priority attribute)
M
main() (in module COMPS.utils.clone_simulation)
(in module COMPS.utils.create_asset_collection)
(in module COMPS.utils.get_output_files_for_experiment)
(in module COMPS.utils.get_output_files_for_workitem)
(in module COMPS.utils.get_output_tail)
(in module COMPS.utils.get_status)
(in module COMPS.utils.main)
(in module COMPS.utils.rerun_failed_simulations_for_experiment)
max_cores() (COMPS.Data.Configuration.Configuration property)
maximum_number_of_retries() (COMPS.Data.Configuration.Configuration property)
md5_checksum() (COMPS.Data.AssetFile.AssetFile property)
Merge (COMPS.Data.TaggableEntity.TagOperationMode attribute)
merge_tags() (COMPS.Data.TaggableEntity.TaggableEntity method)
mime_type() (COMPS.Data.OutputFileMetadata.OutputFileMetadata property)
min_cores() (COMPS.Data.Configuration.Configuration property)
module
COMPS
COMPS.AuthManager
COMPS.Client
COMPS.CredentialPrompt
COMPS.Data
COMPS.Data.AssetCollection
COMPS.Data.AssetCollectionFile
COMPS.Data.AssetFile
COMPS.Data.AssetManager
COMPS.Data.AssetType
COMPS.Data.BaseEntity
COMPS.Data.CommissionableEntity
COMPS.Data.Configuration
COMPS.Data.Experiment
COMPS.Data.HpcJob
COMPS.Data.OutputFileMetadata
COMPS.Data.Priority
COMPS.Data.QueryCriteria
COMPS.Data.RelatableEntity
COMPS.Data.SerializableEntity
COMPS.Data.Simulation
COMPS.Data.SimulationFile
COMPS.Data.Suite
COMPS.Data.TaggableEntity
COMPS.Data.WorkItem
COMPS.Data.WorkItemFile
COMPS.Data.WorkItems
COMPS.Data.WorkItems.BuilderWorkItem
COMPS.utils
COMPS.utils.clone_simulation
COMPS.utils.create_asset_collection
COMPS.utils.get_output_files_for_experiment
COMPS.utils.get_output_files_for_workitem
COMPS.utils.get_output_tail
COMPS.utils.get_status
COMPS.utils.main
COMPS.utils.rerun_failed_simulations_for_experiment
multi-chart
N
name() (COMPS.Data.BaseEntity.EntityType property)
(COMPS.Data.Experiment.Experiment property)
(COMPS.Data.Simulation.Simulation property)
(COMPS.Data.Suite.Suite property)
(COMPS.Data.WorkItem.WorkerOrPluginKey property)
(COMPS.Data.WorkItem.WorkItem property)
node_group_name() (COMPS.Data.Configuration.Configuration property)
Normal (COMPS.Data.Priority.Priority attribute)
NotSet (COMPS.Data.HpcJob.HpcState attribute)
O
offset() (COMPS.Data.QueryCriteria.QueryCriteria method)
orderby() (COMPS.Data.QueryCriteria.QueryCriteria method)
Output (COMPS.Data.AssetType.AssetType attribute)
output_directory_size() (COMPS.Data.HpcJob.HpcJob property)
OutputFileMetadata (class in COMPS.Data.OutputFileMetadata)
owner() (COMPS.Data.Experiment.Experiment property)
(COMPS.Data.Simulation.Simulation property)
(COMPS.Data.Suite.Suite property)
(COMPS.Data.WorkItem.WorkItem property)
P
parse_ISO8601_date() (in module COMPS.Data.SerializableEntity)
parse_namedtuple_from_dict() (in module COMPS.Data.SerializableEntity)
path_builder_simple() (in module COMPS.utils.get_output_files_for_experiment)
(in module COMPS.utils.get_output_files_for_workitem)
path_builder_single_dir() (in module COMPS.utils.get_output_files_for_experiment)
path_from_root() (COMPS.Data.OutputFileMetadata.OutputFileMetadata property)
plugins() (COMPS.Data.WorkItem.WorkItem property)
post() (COMPS.Client.Client class method)
Priority (class in COMPS.Data.Priority)
priority() (COMPS.Data.Configuration.Configuration property)
(COMPS.Data.HpcJob.HpcJob property)
(COMPS.Data.WorkItem.WorkItem property)
prompt() (COMPS.CredentialPrompt.ConsoleCredentialPrompt method)
(COMPS.CredentialPrompt.CredentialPrompt method)
(COMPS.CredentialPrompt.TKCredentialPrompt method)
Provisioning (COMPS.Data.Simulation.SimulationState attribute)
put() (COMPS.Client.Client class method)
py2rest() (COMPS.Data.SerializableEntity.SerializableEntity class method)
Q
QueryCriteria (class in COMPS.Data.QueryCriteria)
Queued (COMPS.Data.HpcJob.HpcState attribute)
R
raise_err_from_resp() (COMPS.Client.Client class method)
refresh() (COMPS.Data.AssetCollection.AssetCollection method)
(COMPS.Data.Experiment.Experiment method)
(COMPS.Data.Simulation.Simulation method)
(COMPS.Data.Suite.Suite method)
(COMPS.Data.WorkItem.WorkItem method)
RelatableEntity (class in COMPS.Data.RelatableEntity)
RelationType (class in COMPS.Data.WorkItem)
relative_path() (COMPS.Data.AssetCollectionFile.AssetCollectionFile property)
Replace (COMPS.Data.TaggableEntity.TagOperationMode attribute)
request() (COMPS.Client.Client class method)
rerun_sims() (in module COMPS.utils.rerun_failed_simulations_for_experiment)
rest2py() (COMPS.Data.SerializableEntity.SerializableEntity class method)
Resumed (COMPS.Data.WorkItem.WorkItemState attribute)
ResumeRequested (COMPS.Data.WorkItem.WorkItemState attribute)
retrieve() (COMPS.Data.AssetFile.AssetFile method)
retrieve_as_zip() (COMPS.Data.AssetCollection.AssetCollection method)
retrieve_asset_files() (in module COMPS.Data.AssetManager)
retrieve_output_file_info() (COMPS.Data.Simulation.Simulation method)
(COMPS.Data.WorkItem.WorkItem method)
(in module COMPS.Data.AssetManager)
retrieve_output_files() (COMPS.Data.Simulation.Simulation method)
(COMPS.Data.WorkItem.WorkItem method)
retrieve_output_files_from_info() (COMPS.Data.Simulation.Simulation method)
(COMPS.Data.WorkItem.WorkItem method)
(in module COMPS.Data.AssetManager)
retrieve_partial_output_file_from_info() (in module COMPS.Data.AssetManager)
Retry (COMPS.Data.Simulation.SimulationState attribute)
Running (COMPS.Data.HpcJob.HpcState attribute)
(COMPS.Data.Simulation.SimulationState attribute)
(COMPS.Data.WorkItem.WorkItemState attribute)
S
save() (COMPS.Data.AssetCollection.AssetCollection method)
(COMPS.Data.Experiment.Experiment method)
(COMPS.Data.Simulation.Simulation method)
(COMPS.Data.Suite.Suite method)
(COMPS.Data.WorkItem.WorkItem method)
save_all() (COMPS.Data.Simulation.Simulation static method)
(COMPS.Data.WorkItem.WorkItem static method)
select() (COMPS.Data.QueryCriteria.QueryCriteria method)
select_children() (COMPS.Data.QueryCriteria.QueryCriteria method)
SerializableEntity (class in COMPS.Data.SerializableEntity)
set_tags() (COMPS.Data.TaggableEntity.TaggableEntity method)
Simulation (class in COMPS.Data.Simulation)
simulation_input_args() (COMPS.Data.Configuration.Configuration property)
SimulationFile (class in COMPS.Data.SimulationFile)
Simulations (COMPS.Data.AssetManager.EntityType attribute)
SimulationState (class in COMPS.Data.Simulation)
start_time() (COMPS.Data.HpcJob.HpcJob property)
state() (COMPS.Data.Simulation.Simulation property)
(COMPS.Data.WorkItem.WorkItem property)
static_retrieve_as_zip() (COMPS.Data.AssetCollection.AssetCollection static method)
static_retrieve_output_files() (COMPS.Data.Simulation.Simulation static method)
(COMPS.Data.WorkItem.WorkItem static method)
submit_time() (COMPS.Data.HpcJob.HpcJob property)
Submitted (COMPS.Data.HpcJob.HpcState attribute)
Succeeded (COMPS.Data.Simulation.SimulationState attribute)
(COMPS.Data.WorkItem.WorkItemState attribute)
Suite (class in COMPS.Data.Suite)
suite_id() (COMPS.Data.Experiment.Experiment property)
suites
T
tag_filters() (COMPS.Data.QueryCriteria.QueryCriteria property)
TaggableEntity (class in COMPS.Data.TaggableEntity)
TagOperationMode (class in COMPS.Data.TaggableEntity)
tags() (COMPS.Data.AssetCollection.AssetCollection property)
(COMPS.Data.AssetCollectionFile.AssetCollectionFile property)
(COMPS.Data.Experiment.Experiment property)
(COMPS.Data.Simulation.Simulation property)
(COMPS.Data.Suite.Suite property)
(COMPS.Data.WorkItem.WorkItem property)
TKCredentialPrompt (class in COMPS.CredentialPrompt)
to_param_dict() (COMPS.Data.QueryCriteria.QueryCriteria method)
U
upload_large_asset() (in module COMPS.Data.AssetManager)
uri() (COMPS.Data.AssetFile.AssetFile property)
url() (COMPS.Data.OutputFileMetadata.OutputFileMetadata property)
username() (COMPS.AuthManager.AuthManager property)
V
Validating (COMPS.Data.HpcJob.HpcState attribute)
(COMPS.Data.WorkItem.WorkItemState attribute)
version() (COMPS.Data.WorkItem.WorkerOrPluginKey property)
W
Waiting (COMPS.Data.WorkItem.WorkItemState attribute)
where() (COMPS.Data.QueryCriteria.QueryCriteria method)
where_tag() (COMPS.Data.QueryCriteria.QueryCriteria method)
work item
work order
worker() (COMPS.Data.WorkItem.WorkItem property)
worker_instance_id() (COMPS.Data.WorkItem.WorkItem property)
WorkerOrPluginKey (class in COMPS.Data.WorkItem)
working_directory() (COMPS.Data.HpcJob.HpcJob property)
(COMPS.Data.WorkItem.WorkItem property)
working_directory_root() (COMPS.Data.Configuration.Configuration property)
working_directory_size() (COMPS.Data.WorkItem.WorkItem property)
WorkItem (class in COMPS.Data.WorkItem)
WorkItemFile (class in COMPS.Data.WorkItemFile)
WorkItems (COMPS.Data.AssetManager.EntityType attribute)
WorkItemState (class in COMPS.Data.WorkItem)
X
xparams() (COMPS.Data.QueryCriteria.QueryCriteria property)