idmtools.entities package¶
Entities is the core entities used to build experiments or used as abstracts for those classes.
Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.
idmtools.entities Subpackages¶
- idmtools.entities.iplatform_ops package
- idmtools.entities.iplatform_ops Submodules
- idmtools.entities.iplatform_ops.iplatform_asset_collection_operations module
- idmtools.entities.iplatform_ops.iplatform_experiment_operations module
- idmtools.entities.iplatform_ops.iplatform_simulation_operations module
- idmtools.entities.iplatform_ops.iplatform_suite_operations module
- idmtools.entities.iplatform_ops.iplatform_workflowitem_operations module
- idmtools.entities.iplatform_ops.utils module
- idmtools.entities.iplatform_ops Submodules
idmtools.entities Submodules¶
- idmtools.entities.command_line module
- idmtools.entities.command_task module
- idmtools.entities.experiment module
ExperimentExperiment.suite_idExperiment.item_typeExperiment.task_typeExperiment.platform_requirementsExperiment.frozenExperiment.gather_common_assets_from_taskExperiment.disable_default_pre_createExperiment.post_creation()Experiment.statusExperiment.suiteExperiment.parentExperiment.display()Experiment.pre_creation()Experiment.doneExperiment.succeededExperiment.any_failedExperiment.simulationsExperiment.simulation_countExperiment.refresh_simulations()Experiment.refresh_simulations_status()Experiment.pre_getstate()Experiment.gather_assets()Experiment.from_task()Experiment.from_builder()Experiment.from_template()Experiment.list_static_assets()Experiment.run()Experiment.to_dict()Experiment.from_id()Experiment.print()Experiment.__init__()
ExperimentSpecification
- idmtools.entities.generic_workitem module
- idmtools.entities.ianalyzer module
- idmtools.entities.iplatform module
IPlatformIPlatform.platform_type_mapIPlatform.supported_typesIPlatform.validate_inputs_types()IPlatform.get_item()IPlatform.get_children()IPlatform.get_children_by_object()IPlatform.get_parent_by_object()IPlatform.get_parent()IPlatform.get_cache_key()IPlatform.create_items()IPlatform.run_items()IPlatform.validate_item_for_analysis()IPlatform.flatten_item()IPlatform.refresh_status()IPlatform.get_files()IPlatform.get_files_by_id()IPlatform.are_requirements_met()IPlatform.is_task_supported()IPlatform.wait_till_done()IPlatform.wait_till_done_progress()IPlatform.get_related_items()IPlatform.is_regather_assets_on_modify()IPlatform.is_windows_platform()IPlatform.common_asset_pathIPlatform.join_path()IPlatform.id_from_file()IPlatform.get_item_from_id_file()IPlatform.get_defaults_by_type()IPlatform.create_sim_directory_map()IPlatform.create_sim_directory_df()IPlatform.save_sim_directory_df_to_csv()IPlatform.__init__()
- idmtools.entities.iplatform_default module
- idmtools.entities.itask module
ITaskITask.platform_requirementsITask.common_assetsITask.transient_assetsITask.commandITask.metadata_fieldsITask.add_pre_creation_hook()ITask.add_post_creation_hook()ITask.add_platform_requirement()ITask.pre_creation()ITask.post_creation()ITask.gather_common_assets()ITask.gather_transient_assets()ITask.gather_all_assets()ITask.copy_simulation()ITask.reload_from_simulation()ITask.to_simulation()ITask.pre_getstate()ITask.post_setstate()ITask.pickle_ignore_fieldsITask.__init__()ITask.to_dict()
- idmtools.entities.iworkflow_item module
IWorkflowItemIWorkflowItem.nameIWorkflowItem.item_nameIWorkflowItem.asset_collection_idIWorkflowItem.tagsIWorkflowItem.transient_assetsIWorkflowItem.asset_filesIWorkflowItem.user_filesIWorkflowItem.taskIWorkflowItem.related_experimentsIWorkflowItem.related_simulationsIWorkflowItem.related_suitesIWorkflowItem.related_work_itemsIWorkflowItem.related_asset_collectionsIWorkflowItem.work_item_typeIWorkflowItem.item_typeIWorkflowItem.gather_assets()IWorkflowItem.add_file()IWorkflowItem.clear_user_files()IWorkflowItem.pre_creation()IWorkflowItem.to_dict()IWorkflowItem.__init__()
- idmtools.entities.platform_requirements module
- idmtools.entities.relation_type module
- idmtools.entities.simulation module
- idmtools.entities.suite module
- idmtools.entities.task_proxy module
- idmtools.entities.templated_simulation module
simulation_generator()TemplatedSimulationsTemplatedSimulations.buildersTemplatedSimulations.base_simulationTemplatedSimulations.base_taskTemplatedSimulations.parentTemplatedSimulations.builderTemplatedSimulations.add_builder()TemplatedSimulations.pickle_ignore_fieldsTemplatedSimulations.display()TemplatedSimulations.simulations()TemplatedSimulations.extra_simulations()TemplatedSimulations.add_simulation()TemplatedSimulations.add_simulations()TemplatedSimulations.new_simulation()TemplatedSimulations.tagsTemplatedSimulations.__init__()TemplatedSimulations.from_task()