idmtools_platform_comps package

idmtools comps platform.

We try to load the CLI here but if idmtools-cli is not installed, we fail gracefully.

Copyright 2021, Bill & Melinda Gates Foundation. All rights reserved.

idmtools_platform_comps Subpackages

• idmtools_platform_comps.cli package
  • idmtools_platform_comps.cli Submodules
    • idmtools_platform_comps.cli.cli_functions module
      • validate_range()
      • environment_list()
    • idmtools_platform_comps.cli.comps module
      • add_item()
      • StaticCredentialPrompt
• idmtools_platform_comps.comps_operations package
  • idmtools_platform_comps.comps_operations Submodules
    • idmtools_platform_comps.comps_operations.asset_collection_operations module
      • CompsPlatformAssetCollectionOperations
    • idmtools_platform_comps.comps_operations.experiment_operations module
      • CompsPlatformExperimentOperations
    • idmtools_platform_comps.comps_operations.simulation_operations module
      • comps_batch_worker()
      • CompsPlatformSimulationOperations
    • idmtools_platform_comps.comps_operations.suite_operations module
      • CompsPlatformSuiteOperations
    • idmtools_platform_comps.comps_operations.workflow_item_operations module
      • CompsPlatformWorkflowItemOperations
• idmtools_platform_comps.ssmt_operations package
  • idmtools_platform_comps.ssmt_operations Submodules
    • idmtools_platform_comps.ssmt_operations.simulation_operations module
      • SSMTPlatformSimulationOperations
    • idmtools_platform_comps.ssmt_operations.workflow_item_operations module
      • SSMTPlatformWorkflowItemOperations
• idmtools_platform_comps.ssmt_work_items package
  • idmtools_platform_comps.ssmt_work_items Submodules
    • idmtools_platform_comps.ssmt_work_items.comps_work_order_task module
      • CompsWorkOrderTask
    • idmtools_platform_comps.ssmt_work_items.comps_workitems module
      • SSMTWorkItem
      • InputDataWorkItem
      • VisToolsWorkItem
    • idmtools_platform_comps.ssmt_work_items.icomps_workflowitem module
      • ICOMPSWorkflowItem
    • idmtools_platform_comps.ssmt_work_items.work_order module
      • IWorkOrder
      • ExecutionDefinition
      • DockerWorkOrder
      • BuildFlags
      • BuildDefinition
      • ImageBuilderWorkOrder
• idmtools_platform_comps.utils package
  • idmtools_platform_comps.utils Subpackages
    • idmtools_platform_comps.utils.assetize_output package
      • idmtools_platform_comps.utils.assetize_output Submodules
    • idmtools_platform_comps.utils.download package
      • idmtools_platform_comps.utils.download Submodules
    • idmtools_platform_comps.utils.python_requirements_ac package
      • idmtools_platform_comps.utils.python_requirements_ac Submodules
    • idmtools_platform_comps.utils.ssmt_utils package
      • idmtools_platform_comps.utils.ssmt_utils Submodules
  • idmtools_platform_comps.utils Submodules
    • idmtools_platform_comps.utils.download_experiment module
      • get_script_extension()
      • download_asset()
      • write_script()
      • write_experiment_script()
      • download_experiment()
    • idmtools_platform_comps.utils.file_filter_workitem module
      • CrossEnvironmentFilterNotSupport
      • AtLeastOneItemToWatch
      • FileFilterWorkItem
    • idmtools_platform_comps.utils.general module
      • fatal_code()
      • convert_comps_status()
      • convert_comps_workitem_status()
      • clean_experiment_name()
      • get_file_from_collection()
      • get_file_as_generator()
      • Workitem
      • get_asset_for_comps_item()
      • update_item()
      • generate_ac_from_asset_md5()
      • generate_ac_from_asset_md5_file()
      • save_sif_asset_md5_from_ac_id()
    • idmtools_platform_comps.utils.linux_mounts module
      • set_linux_mounts()
      • clear_linux_mounts()
      • get_workdir_from_simulations()
    • idmtools_platform_comps.utils.lookups module
      • get_experiment_by_id()
      • get_simulation_by_id()
      • get_all_experiments_for_user()
      • get_simulations_from_big_experiments()
    • idmtools_platform_comps.utils.package_version module
      • PackageHTMLParser
      • LinkHTMLParser
      • LinkNameParser
      • get_latest_package_version_from_pypi()
      • get_latest_pypi_package_version_from_artifactory()
      • get_pypi_package_versions_from_artifactory()
      • get_latest_ssmt_image_version_from_artifactory()
      • get_docker_manifest()
      • get_digest_from_docker_hub()
      • fetch_versions_from_server()
      • fetch_versions_from_artifactory()
      • get_versions_from_site()
      • get_latest_version_from_site()
      • fetch_package_versions_from_pypi()
      • fetch_package_versions()
      • get_highest_version()
      • get_latest_version()
      • get_latest_compatible_version()
    • idmtools_platform_comps.utils.python_version module
      • platform_task_hooks()
    • idmtools_platform_comps.utils.scheduling module
      • default_add_workorder_sweep_callback()
      • default_add_schedule_config_sweep_callback()
      • scheduled()
      • add_work_order()
      • add_schedule_config()
    • idmtools_platform_comps.utils.singularity_build module
      • SingularityBuildWorkItem
    • idmtools_platform_comps.utils.spatial_output module
      • SpatialOutput

idmtools_platform_comps Submodules

• idmtools_platform_comps.comps_cli module
  • CompsCLI
    • CompsCLI.get_experiment_status()
    • CompsCLI.get_simulation_status()
    • CompsCLI.get_platform_information()
  • COMPSCLISpecification
    • COMPSCLISpecification.get()
    • COMPSCLISpecification.get_additional_commands()
    • COMPSCLISpecification.get_description()
• idmtools_platform_comps.comps_platform module
  • COMPSPriority
    • COMPSPriority.Lowest
    • COMPSPriority.BelowNormal
    • COMPSPriority.Normal
    • COMPSPriority.AboveNormal
    • COMPSPriority.Highest
  • COMPSPlatform
    • COMPSPlatform.MAX_SUBDIRECTORY_LENGTH
    • COMPSPlatform.endpoint
    • COMPSPlatform.environment
    • COMPSPlatform.priority
    • COMPSPlatform.simulation_root
    • COMPSPlatform.node_group
    • COMPSPlatform.num_retries
    • COMPSPlatform.num_cores
    • COMPSPlatform.max_workers
    • COMPSPlatform.batch_size
    • COMPSPlatform.min_time_between_commissions
    • COMPSPlatform.exclusive
    • COMPSPlatform.docker_image
    • COMPSPlatform.post_setstate()
    • COMPSPlatform.get_workitem_link()
    • COMPSPlatform.get_asset_collection_link()
    • COMPSPlatform.get_username()
    • COMPSPlatform.is_windows_platform()
    • COMPSPlatform.validate_item_for_analysis()
    • COMPSPlatform.get_files()
    • COMPSPlatform.flatten_item()
    • COMPSPlatform.__init__()
• idmtools_platform_comps.plugin_info module
  • COMPSPlatformSpecification
    • COMPSPlatformSpecification.__init__()
    • COMPSPlatformSpecification.get_description()
    • COMPSPlatformSpecification.get()
    • COMPSPlatformSpecification.example_configuration()
    • COMPSPlatformSpecification.get_type()
    • COMPSPlatformSpecification.get_example_urls()
    • COMPSPlatformSpecification.get_version()
    • COMPSPlatformSpecification.get_configuration_aliases()
  • SSMTPlatformSpecification
    • SSMTPlatformSpecification.__init__()
    • SSMTPlatformSpecification.get_description()
    • SSMTPlatformSpecification.get()
    • SSMTPlatformSpecification.example_configuration()
    • SSMTPlatformSpecification.get_type()
    • SSMTPlatformSpecification.get_example_urls()
    • SSMTPlatformSpecification.get_version()
    • SSMTPlatformSpecification.get_configuration_aliases()
• idmtools_platform_comps.ssmt_platform module
  • SSMTPlatform
    • SSMTPlatform.__init__()