idmtools package

idmtools core package.

This init installs a system exception hook for idmtools. It also ensures the configuration is loaded.

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

idmtools Subpackages

• idmtools.analysis package
  • idmtools.analysis Submodules
    • idmtools.analysis.add_analyzer module
      • AddAnalyzer
    • idmtools.analysis.analyze_manager module
      • pool_worker_initializer()
      • AnalyzeManager
    • idmtools.analysis.csv_analyzer module
      • CSVAnalyzer
    • idmtools.analysis.download_analyzer module
      • DownloadAnalyzer
    • idmtools.analysis.map_worker_entry module
      • map_item()
    • idmtools.analysis.platform_analysis_bootstrap module
    • idmtools.analysis.platform_anaylsis module
      • PlatformAnalysis
    • idmtools.analysis.tags_analyzer module
      • TagsAnalyzer
• idmtools.assets package
  • idmtools.assets Submodules
    • idmtools.assets.asset module
      • Asset
    • idmtools.assets.asset_collection module
      • AssetCollection
    • idmtools.assets.content_handlers module
      • json_handler()
    • idmtools.assets.errors module
      • DuplicatedAssetError
    • idmtools.assets.file_list module
      • FileList
• idmtools.builders package
  • idmtools.builders Submodules
    • idmtools.builders.arm_simulation_builder module
      • ArmSimulationBuilder
    • idmtools.builders.csv_simulation_builder module
      • CsvExperimentBuilder
    • idmtools.builders.simulation_builder module
      • SimulationBuilder
    • idmtools.builders.sweep_arm module
      • ArmType
      • SweepArm
    • idmtools.builders.yaml_simulation_builder module
      • DefaultParamFuncDict
      • YamlSimulationBuilder
• idmtools.config package
  • idmtools.config Submodules
    • idmtools.config.idm_config_parser module
      • initialization()
      • IdmConfigParser
• idmtools.core package
  • idmtools.core Subpackages
    • idmtools.core.interfaces package
      • idmtools.core.interfaces Submodules
  • idmtools.core Submodules
    • idmtools.core.cache_enabled module
      • CacheEnabled
    • idmtools.core.context module
      • set_current_platform()
      • remove_current_platform()
      • clear_context()
      • get_current_platform()
    • idmtools.core.docker_task module
      • DockerTask
      • DockerTaskSpecification
    • idmtools.core.enums module
      • EntityStatus
      • FilterMode
      • ItemType
    • idmtools.core.exceptions module
      • ExperimentNotFound
      • UnknownItemException
      • NoPlatformException
      • TopLevelItem
      • UnsupportedPlatformType
      • NoTaskFound
      • idmtools_error_handler()
    • idmtools.core.experiment_factory module
      • ExperimentFactory
    • idmtools.core.id_file module
      • read_id_file()
      • write_id_file()
    • idmtools.core.logging module
      • IdmToolsLoggingConfig
      • MultiProcessSafeRotatingFileHandler
      • PrintHandler
      • 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
      • LinuxSystemInformation
      • WindowsSystemInformation
      • get_system_information()
    • idmtools.core.task_factory module
      • DynamicTaskSpecification
      • TaskFactory
• idmtools.entities package
  • idmtools.entities Subpackages
    • idmtools.entities.iplatform_ops package
      • idmtools.entities.iplatform_ops Submodules
  • idmtools.entities Submodules
    • idmtools.entities.command_line module
      • CommandLine
    • idmtools.entities.command_task module
      • CommandTask
      • CommandTaskSpecification
    • idmtools.entities.experiment module
      • Experiment
      • ExperimentSpecification
    • idmtools.entities.generic_workitem module
      • GenericWorkItem
    • idmtools.entities.ianalyzer module
      • IAnalyzer
      • BaseAnalyzer
    • idmtools.entities.iplatform module
      • IPlatform
    • idmtools.entities.iplatform_default module
      • IPlatformDefault
      • default_cpu_count()
      • AnalyzerManagerPlatformDefault
    • idmtools.entities.itask module
      • ITask
    • idmtools.entities.iworkflow_item module
      • IWorkflowItem
    • idmtools.entities.platform_requirements module
      • PlatformRequirements
    • idmtools.entities.relation_type module
      • RelationType
    • idmtools.entities.simulation module
      • Simulation
    • idmtools.entities.suite module
      • Suite
    • idmtools.entities.task_proxy module
      • TaskProxy
    • idmtools.entities.templated_simulation module
      • simulation_generator()
      • TemplatedSimulations
• idmtools.plugins package
  • idmtools.plugins Submodules
    • idmtools.plugins.git_commit module
      • idmtools_platform_pre_create_item()
      • add_details_using_gitpython()
      • add_details_using_pygit()
    • idmtools.plugins.item_sequence module
      • load_existing_sequence_data()
      • get_plugin_config()
      • idmtools_generate_id()
      • idmtools_platform_post_run()
    • idmtools.plugins.uuid_generator module
      • idmtools_generate_id()
• idmtools.registry package
  • idmtools.registry Submodules
    • idmtools.registry.experiment_specification module
      • ExperimentPluginSpecification
      • ExperimentPlugins
    • idmtools.registry.functions module
      • FunctionPluginManager
    • idmtools.registry.hook_specs module
      • idmtools_platform_pre_create_item()
      • idmtools_platform_post_create_item()
      • idmtools_platform_post_run()
      • idmtools_on_start()
      • idmtools_generate_id()
      • idmtools_runnable_on_done()
      • idmtools_runnable_on_succeeded()
      • idmtools_runnable_on_failure()
    • idmtools.registry.master_plugin_registry module
      • MasterPluginRegistry
    • idmtools.registry.platform_specification module
      • PlatformSpecification
      • PlatformPlugins
    • idmtools.registry.plugin_specification module
      • ProjectTemplate
      • PluginSpecification
    • idmtools.registry.task_specification module
      • TaskSpecification
      • TaskPlugins
    • idmtools.registry.utils module
      • is_a_plugin_of_type()
      • load_plugin_map()
      • plugins_loader()
      • discover_plugins_from()
• idmtools.services package
  • idmtools.services Submodules
    • idmtools.services.ipersistance_service module
      • IPersistenceService
    • idmtools.services.platforms module
      • PlatformPersistService
• idmtools.utils package
  • idmtools.utils Subpackages
    • idmtools.utils.display package
      • display()
      • idmtools.utils.display Submodules
    • idmtools.utils.filters package
      • idmtools.utils.filters Submodules
  • idmtools.utils Submodules
    • idmtools.utils.caller module
      • get_caller()
    • idmtools.utils.collections module
      • cut_iterable_to()
      • ExperimentParentIterator
      • ResetGenerator
      • duplicate_list_of_generators()
    • idmtools.utils.command_line module
      • suppress_output()
    • idmtools.utils.decorators module
      • abstractstatic
      • optional_decorator()
      • SingletonMixin
      • cache_for()
      • optional_yaspin_load()
      • ParallelizeDecorator
      • check_symlink_capabilities()
    • idmtools.utils.dropbox_location module
      • get_current_user()
      • get_dropbox_location()
    • idmtools.utils.entities module
      • get_dataclass_common_fields()
      • as_dict()
      • validate_user_inputs_against_dataclass()
      • get_default_tags()
      • save_id_as_file_as_hook()
    • idmtools.utils.file module
      • scan_directory()
      • file_content_to_generator()
      • content_generator()
    • idmtools.utils.file_parser module
      • FileParser
    • idmtools.utils.filter_simulations module
      • FilterItem
    • idmtools.utils.gitrepo module
      • GitRepo
    • idmtools.utils.hashing module
      • Hasher
      • hash_obj()
      • ignore_fields_in_dataclass_on_pickle()
      • calculate_md5()
      • calculate_md5_stream()
    • idmtools.utils.info module
      • get_doc_base_url()
      • get_pip_packages_10_to_6()
      • get_pip_packages_6_to_9()
      • get_pip_packages_10_to_current()
      • get_packages_from_pip()
      • get_packages_list()
      • get_help_version_url()
    • idmtools.utils.json module
      • IDMJSONEncoder
      • load_json_file()
    • idmtools.utils.language module
      • on_off()
      • pluralize()
      • verbose_timedelta()
      • get_qualified_class_name()
      • get_qualified_class_name_from_obj()
    • idmtools.utils.local_os module
      • LocalOS
    • idmtools.utils.time module
      • timestamp()