Configuration¶

This module provides configuration management for DeepMIMO through a singleton configuration instance.

The configuration interface is provided through a singleton instance deepmimo.config:

Singleton configuration class for DeepMIMO.

This class implements a singleton pattern to ensure there's only one configuration instance throughout the application.

set ¶

set(key, value)

Set a configuration value.

Parameters:

Name	Type	Description	Default
`key`	`str`	The configuration key to set.	required
`value`	`Any`	The value to set for the configuration key.	required

get ¶

get(key, default=None)

Get a configuration value.

Parameters:

Name	Type	Description	Default
`key`	`str`	The configuration key to get.	required
`default`	`Any`	The default value to return if the key doesn't exist.	`None`

Returns:

Name	Type	Description
`Any`	`Any`	The configuration value for the given key, or the default value
	`Any`	if the key doesn't exist.

reset ¶

reset()

Reset all configuration values to their defaults.

get_config_str ¶

get_config_str()

Return a string representation of the configuration.

print_config ¶

print_config()

Print all current configuration values.

get_all ¶

get_all()

Get all configuration values.

Returns:

Name	Type	Description
`dict`	`dict[str, Any]`	A dictionary containing all configuration values.

Basic Usage¶

import deepmimo as dm

# Set with parameter names
dm.config('sionna_version', '0.19.1')

# Set with keywords
dm.config(use_gpu=True, gpu_device_id=1)

# Get current value
dm.config('ray_tracer_version')

# Print current config
dm.config()

# Reset to defaults
dm.config.reset()

Default Configurations¶

Parameter	Description	Default Value
`wireless_insite_version`	Default Wireless InSite version	`3.3.0`
`sionna_version`	Default Sionna version	`0.19.1`
`aodt_version`	Default AODT version	`1.x`
`use_gpu`	Whether to use GPU acceleration	`False`
`gpu_device_id`	GPU device ID to use	`0`
`scenarios_folder`	Folder containing scenarios files	`'deepmimo_scenarios'`