examples.systems.registry

SYSTEM_REGISTRY: Dict[str, Dict[str, Any]] = {'duffing': {'system_class': <class 'examples.systems.duffing_oscillator.DuffingOscillator'>, 'parameter_class': <class 'examples.systems.parameters.duffing_oscillator.PhysicalDuffingParameters'>, 'description': 'A forced, damped oscillator with a nonlinear restoring force.', 'is_implemented': True, 'state_variables': ['q', 'v', 'xi'], 'state_units': ['m', 'm/s', 'N/A'], 'has_external_forcing': True, 'default_hidden_layers': [128, 128, 128], 'state_dimension': 2, 'full_state_dimension': 3}}
def get_system_info(system_name: str) -> Dict[str, Any]:

Retrieve information about a system from the registry.

Arguments:
  • system_name: The name of the system.
Returns:

A dictionary containing system information.

Raises:
  • ValueError: If the system is not found in the registry.
def get_available_systems() -> List[str]:

Get a list of all available system names.

Returns:

A list of strings with the names of the systems.

def get_implemented_systems() -> List[str]:

Get a list of implemented system names.

Returns:

A list of strings with the names of the implemented systems.