idmtools.core package

Core area classes are defined in this packaged.

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

idmtools.core Subpackages

• idmtools.core.interfaces package
  • idmtools.core.interfaces Submodules
    • idmtools.core.interfaces.entity_container module
      • EntityContainer
    • idmtools.core.interfaces.iassets_enabled module
      • IAssetsEnabled
    • idmtools.core.interfaces.ientity module
      • IEntity
    • idmtools.core.interfaces.iitem module
      • get_id_generator()
      • IItem
    • idmtools.core.interfaces.imetadata_operations module
      • IMetadataOperations
    • idmtools.core.interfaces.inamed_entity module
      • INamedEntity
    • idmtools.core.interfaces.irunnable_entity module
      • IRunnableEntity

idmtools.core Submodules

• idmtools.core.cache_enabled module
  • CacheEnabled
    • CacheEnabled.initialize_cache()
    • CacheEnabled.cleanup_cache()
    • CacheEnabled.cache
• idmtools.core.context module
  • set_current_platform()
  • remove_current_platform()
  • clear_context()
  • get_current_platform()
• idmtools.core.docker_task module
  • DockerTask
    • DockerTask.image_name
    • DockerTask.build
    • DockerTask.build_path
    • DockerTask.Dockerfile
    • DockerTask.pull_before_build
    • DockerTask.use_nvidia_run
    • DockerTask.gather_common_assets()
    • DockerTask.gather_transient_assets()
    • DockerTask.build_image()
    • DockerTask.reload_from_simulation()
    • DockerTask.__init__()
  • DockerTaskSpecification
    • DockerTaskSpecification.get()
    • DockerTaskSpecification.get_description()
    • DockerTaskSpecification.get_type()
• idmtools.core.enums module
  • EntityStatus
    • EntityStatus.COMMISSIONING
    • EntityStatus.CREATED
    • EntityStatus.RUNNING
    • EntityStatus.SUCCEEDED
    • EntityStatus.FAILED
  • FilterMode
    • FilterMode.AND
    • FilterMode.OR
  • ItemType
    • ItemType.SUITE
    • ItemType.EXPERIMENT
    • ItemType.SIMULATION
    • ItemType.WORKFLOW_ITEM
    • ItemType.ASSETCOLLECTION
• idmtools.core.exceptions module
  • ExperimentNotFound
    • ExperimentNotFound.__init__()
  • UnknownItemException
  • NoPlatformException
  • TopLevelItem
  • UnsupportedPlatformType
  • NoTaskFound
  • idmtools_error_handler()
• idmtools.core.experiment_factory module
  • ExperimentFactory
    • ExperimentFactory.DEFAULT_KEY
    • ExperimentFactory.__init__()
    • ExperimentFactory.create()
• idmtools.core.id_file module
  • read_id_file()
  • write_id_file()
• idmtools.core.logging module
  • IdmToolsLoggingConfig
    • IdmToolsLoggingConfig.level
    • IdmToolsLoggingConfig.filename
    • IdmToolsLoggingConfig.console
    • IdmToolsLoggingConfig.file_level
    • IdmToolsLoggingConfig.force
    • IdmToolsLoggingConfig.file_log_format_str
    • IdmToolsLoggingConfig.user_log_format_str
    • IdmToolsLoggingConfig.use_colored_logs
    • IdmToolsLoggingConfig.user_output
    • IdmToolsLoggingConfig.enable_file_logging
    • IdmToolsLoggingConfig.__init__()
  • MultiProcessSafeRotatingFileHandler
    • MultiProcessSafeRotatingFileHandler.__init__()
    • MultiProcessSafeRotatingFileHandler.handle()
    • MultiProcessSafeRotatingFileHandler.doRollover()
  • PrintHandler
    • PrintHandler.handle()
  • setup_logging()
  • setup_handlers()
  • setup_user_logger()
  • setup_user_print_logger()
  • set_file_logging()
  • create_file_handler()
  • reset_logging_handlers()
  • exclude_logging_classes()
• idmtools.core.platform_factory module
  • platform()
  • Platform
• idmtools.core.system_information module
  • get_data_directory()
  • get_filtered_environment_vars()
  • SystemInformation
    • SystemInformation.data_directory
    • SystemInformation.user
    • SystemInformation.python_version
    • SystemInformation.python_build
    • SystemInformation.python_implementation
    • SystemInformation.python_packages
    • SystemInformation.environment_variables
    • SystemInformation.os_name
    • SystemInformation.hostname
    • SystemInformation.system_version
    • SystemInformation.system_architecture
    • SystemInformation.system_processor
    • SystemInformation.system_architecture_details
    • SystemInformation.default_docket_socket_path
    • SystemInformation.cwd
    • SystemInformation.user_group_str
    • SystemInformation.version
    • SystemInformation.__init__()
  • LinuxSystemInformation
    • LinuxSystemInformation.__init__()
  • WindowsSystemInformation
    • WindowsSystemInformation.default_docket_socket_path
  • get_system_information()
• idmtools.core.task_factory module
  • DynamicTaskSpecification
    • DynamicTaskSpecification.__init__()
    • DynamicTaskSpecification.get()
    • DynamicTaskSpecification.get_description()
    • DynamicTaskSpecification.get_type()
  • TaskFactory
    • TaskFactory.DEFAULT_KEY
    • TaskFactory.__init__()
    • TaskFactory.register()
    • TaskFactory.register_task()
    • TaskFactory.create()