idmtools_platform_local package

idmtools local platform.

The local platform allows running experiments locally using docker.

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

idmtools_platform_local Subpackages

• idmtools_platform_local.cli package
  • idmtools_platform_local.cli Submodules
    • idmtools_platform_local.cli.experiment module
      • prettify_experiment()
      • status()
      • extra_commands()
    • idmtools_platform_local.cli.local module
      • LocalCliContext
      • cli_command_type
      • stop_services()
      • container_status_text()
    • idmtools_platform_local.cli.simulation module
      • prettify_simulation()
      • status()
    • idmtools_platform_local.cli.utils module
      • get_service_info()
      • colorize_status()
      • parent_status_to_progress()
      • urlize_data_path()
• idmtools_platform_local.client package
  • idmtools_platform_local.client Submodules
    • idmtools_platform_local.client.base module
      • BaseClient
    • idmtools_platform_local.client.experiments_client module
      • ExperimentsClient
    • idmtools_platform_local.client.healthcheck_client module
      • HealthcheckClient
    • idmtools_platform_local.client.simulations_client module
      • SimulationsClient
• idmtools_platform_local.infrastructure package
  • idmtools_platform_local.infrastructure Submodules
    • idmtools_platform_local.infrastructure.base_service_container module
      • BaseServiceContainer
    • idmtools_platform_local.infrastructure.docker_io module
      • DockerIO
    • idmtools_platform_local.infrastructure.postgres module
      • PostgresContainer
    • idmtools_platform_local.infrastructure.redis module
      • RedisContainer
    • idmtools_platform_local.infrastructure.service_manager module
      • DockerServiceManager
    • idmtools_platform_local.infrastructure.workers module
      • get_worker_image_default()
      • WorkersContainer
• idmtools_platform_local.platform_operations package
  • idmtools_platform_local.platform_operations Submodules
    • idmtools_platform_local.platform_operations.experiment_operations module
      • LocalPlatformExperimentOperations
    • idmtools_platform_local.platform_operations.simulation_operations module
      • LocalPlatformSimulationOperations
    • idmtools_platform_local.platform_operations.utils module
      • ExperimentDict
      • SimulationDict
      • local_status_to_common()
      • download_lp_file()

idmtools_platform_local Submodules

• idmtools_platform_local.config module
  • get_api_path()
• idmtools_platform_local.local_cli module
  • LocalCLI
    • LocalCLI.get_experiment_status()
    • LocalCLI.get_simulation_status()
    • LocalCLI.get_platform_information()
  • LocalCLISpecification
    • LocalCLISpecification.get()
    • LocalCLISpecification.get_additional_commands()
    • LocalCLISpecification.get_description()
• idmtools_platform_local.local_platform module
  • LocalPlatform
    • LocalPlatform.host_data_directory
    • LocalPlatform.network
    • LocalPlatform.redis_image
    • LocalPlatform.redis_port
    • LocalPlatform.runtime
    • LocalPlatform.redis_mem_limit
    • LocalPlatform.redis_mem_reservation
    • LocalPlatform.postgres_image
    • LocalPlatform.postgres_mem_limit
    • LocalPlatform.postgres_mem_reservation
    • LocalPlatform.postgres_port
    • LocalPlatform.workers_mem_limit
    • LocalPlatform.workers_mem_reservation
    • LocalPlatform.workers_image
    • LocalPlatform.workers_ui_port
    • LocalPlatform.heartbeat_timeout
    • LocalPlatform.default_timeout
    • LocalPlatform.launch_created_experiments_in_browser
    • LocalPlatform.auto_remove_worker_containers
    • LocalPlatform.enable_singularity_support
    • LocalPlatform.cleanup()
    • LocalPlatform.post_setstate()
    • LocalPlatform.__init__()
• idmtools_platform_local.plugin_info module
  • LocalPlatformSpecification
    • LocalPlatformSpecification.get_description()
    • LocalPlatformSpecification.get()
    • LocalPlatformSpecification.example_configuration()
    • LocalPlatformSpecification.get_type()
    • LocalPlatformSpecification.get_version()
• idmtools_platform_local.status module
  • Status
    • Status.created
    • Status.in_progress
    • Status.canceled
    • Status.failed
    • Status.done