Source Code Documentation

• Control
  • experiment_graph.py
    • CACHED_DECORATOR_OBJECTS
    • AbstractPlugin
    • DecorationError
    • DecoratorConflictError
    • Edge
    • EdgeIterator
    • ExperimentGraph
    • ExperimentGraphDecorable
    • IncorrectConflictHandlerError
    • NoSuchVertexError
    • Vertex
    • VertexIterator
    • require_class
  • model_component.py
    • ModelComponent
  • model_component_install.py
    • InstallPrompt
    • ModelComponentInstall
  • model_component_manager.py
    • InvalidDefaultProviderError
    • InvalidStateError
    • ModelComponentManager
    • NoDefaultProviderError
  • dependency_graph.py
    • DependencyGraph
    • InvalidNodeError
    • TopologicalCompare
    • UnsatisfiableDependenciesError
  • model_component_dependency_graph.py
    • ModelComponentDependencyGraph
  • image_store.py
    • ImageStore
  • repository_db.py
    • RepositoryDb
  • model_component_iterator.py
    • ModelComponentIterator
  • model_component_path_iterator.py
    • ModelComponentPathIterator
  • model_component_exceptions.py
    • MissingImageError
    • MissingRequiredVMResourcesError
    • MissingVmResourceError
    • ModelComponentImportError
  • utils/new_model_component.py
    • ARGUMENT_PROMPT_SECTIONS
    • ARG_DESCRIPTION
    • ModelComponentGenerator
    • PythonModule
    • check_and_prompt_args()
    • check_required_args()
    • get_arg_parser()
    • main()
    • prompt_arg()
    • python_file()
  • utils/vm_builder.py
    • VMBuilder
    • main()
    • resolve_cdroms()
  • utils/paths.py
    • ERROR_INVALID_NAME
    • is_path_creatable()
    • is_path_exists_or_creatable()
    • is_path_exists_or_creatable_portable()
    • is_path_sibling_creatable()
    • is_pathname_valid()
  • New Model Component Templates
• Configuration
  • config
  • config
  • Config
    • Config.__init__()
    • Config._config_template_path
    • Config._default_config_path
    • Config._load_config_file()
    • Config._update_minimega_config_value()
    • Config.check_cluster()
    • Config.check_config()
    • Config.check_minimega_config()
    • Config.convert_logging()
    • Config.generate_config_from_defaults()
    • Config.get_config()
    • Config.resolve_get()
    • Config.resolve_key()
    • Config.resolve_set()
    • Config.set_config()
    • Config.write()
• CLI
  • firewheel_cli.py
    • FirewheelCLI
    • main()
  • configure_firewheel.py
    • ConfigureFirewheel
  • helper_group.py
    • HelperGroup
  • helper.py
    • Helper
  • host_accessor.py
    • ClusterHandler
    • HostAccessor
    • sync()
  • init_firewheel.py
    • InitFirewheel
  • section.py
    • MalformedSectionError
    • Section
  • executable_section.py
    • BadExecutorError
    • ExecutableSection
    • IllegalListError
  • utils.py
    • HelperNotFoundError
    • InvalidHelperTypeError
    • ParallelSSHManager
    • RichDefaultTable
    • SCPManager
    • SSHManager
    • _SSHProtocolManager
    • build_helper_dict()
    • load_helper()
    • parse_destination()
    • parse_location()
    • parse_to_helper()
    • process_helper_group()
    • strip_markup_chrs()
  • executors/abstract_executor.py
    • AbstractExecutor
  • executors/helpers.py
    • Helpers
  • executors/local_python.py
    • LocalPython
  • executors/python.py
    • Python
  • executors/shell.py
    • Shell
  • completion/actions.py
    • get_available_cli_commands()
    • get_model_component_names()
    • get_total_model_components_size()
  • completion/get_available_cli_commands.py
  • completion/get_model_component_names.py
  • completion/get_total_model_components_size.py
  • completion/prepare_completion_script.py
    • display_instructions()
    • main()
    • populate_template()
    • print_completion_script_path()
• Lib
  • log.py
    • Log
    • UTCLog
  • utilities.py
    • badlink()
    • badpath()
    • get_safe_tarfile_members()
    • hash_file()
    • render_rich_string()
    • retry()
    • strtobool()
  • grpc/firewheel_grpc_client.py
    • FirewheelGrpcClient
  • grpc/firewheel_grpc_server.py
    • FirewheelServicer
    • serve()
  • grpc/firewheel_grpc_resources
    • msg_to_dict()
  • grpc/firewheel_grpc_pb2_grpc
    • Firewheel
    • FirewheelServicer
    • FirewheelStub
    • add_FirewheelServicer_to_server()
  • grpc/firewheel_grpc_pb2
    • CountVMMappingsNotReadyRequest
    • CountVMMappingsNotReadyResponse
    • DestroyAllVMMappingsRequest
    • DestroyAllVMMappingsResponse
    • DestroyVMMappingResponse
    • ExperimentLaunchTime
    • ExperimentStartTime
    • GetExperimentLaunchTimeRequest
    • GetExperimentStartTimeRequest
    • GetInfoRequest
    • GetInfoResponse
    • InitializeExperimentStartTimeRequest
    • InitializeExperimentStartTimeResponse
    • ListRepositoriesRequest
    • ListVMMappingsRequest
    • RemoveAllRepositoriesRequest
    • RemoveAllRepositoriesResponse
    • RemoveRepositoryResponse
    • Repository
    • SetRepositoryResponse
    • SetVMStateByUUIDRequest
    • SetVMTimeByUUIDRequest
    • VMMapping
    • VMMappingUUID
  • FIREWHEEL gRPC Protocol
  • minimega/api.py
    • minimegaAPI
  • minimega/file_store.py
    • FileStore
    • FileStoreFile
  • discovery/api.py
    • discoveryAPI
• VM Resource Manager
  • VM Resource Manager API Reference
    • add_experiment_start_time()
    • add_vm()
    • add_vm_resource_file()
    • destroy_all()
    • get_experiment_launch_time()
    • get_experiment_start_time()
    • get_experiment_time_since_start()
    • get_experiment_time_to_start()
    • get_vm_states()
    • get_vm_times()
    • set_experiment_launch_time()
    • vm_resource_list()
  • experiment_start.py
    • ExperimentStart
  • schedule_db.py
    • ScheduleDb
    • ScheduleDbTimeoutError
  • schedule_entry.py
    • ScheduleEntry
  • schedule_event.py
    • ScheduleEvent
    • ScheduleEventType
  • schedule_updater.py
    • ScheduleUpdater
  • utils.py
    • get_vm_count_not_ready()
    • set_vm_state()
    • set_vm_time()
  • vm_mapping.py
    • VMMapping
  • vm_resource_handler.py
    • VMResourceHandler
  • vm_resource_store.py
    • VmResourceStore
  • abstract_driver.py
    • AbstractDriver
  • Qemu Guest Agent Driver API Reference
    • QemuGuestAgentDriver