Skip to content

Config dataclass

Config()

Configuration class for mechaphlowers settings.

This class is not intended to be used directly. Other classes are using the options instance to provide configuration settings. Default values are set in the class. options is available in the module mechaphlowers.config.

Attributes:

Name Type Description
graphics_resolution int

Resolution of the graphics.

graphics_marker_size float

Size of the markers in the graphics.

Source code in src/mechaphlowers/config.py
196
197
198
199
200
201
202
203
204
205
def __init__(self):
    self._graphics = GraphicsConfig()
    self._solver = SolverConfig()
    self._compute_config = ComputeConfig()
    self._precision = PrecisionConfig()
    self._output_units = OutputUnitsConfig()
    self._ground = GroundConfig()
    self._log = LogConfig()
    self._input_units = InputUnitsConfig()
    self._data_config = DataConfig()

compute property

compute: ComputeConfig

Dataframe configuration property.

graphics property

graphics: GraphicsConfig

Graphics configuration property.

ground property

ground: GroundConfig

Ground configuration property.

input_units property

input_units: InputUnitsConfig

Input units configuration property.

log property

log: LogConfig

Logging configuration property.

output_units property

output_units: OutputUnitsConfig

Output units configuration property.

precision property

precision: PrecisionConfig

Precision configuration property.

solver property

solver: SolverConfig

Solver configuration property.

OptionError

OptionError(message: str)

Bases: Exception

Exception raised when an option is not available.

Source code in src/mechaphlowers/config.py
254
255
def __init__(self, message: str):
    super().__init__(message)