optiSLang Python API 2026 R1

py_omdb

Last update: 05.08.2026

Load and inspect optiSLang OMDB files with Python:

from py_omdb import PyOMDB

omdb = PyOMDB("/path/to/my.omdb")

for param_name in omdb.get_parameter_names():
    print(param_name)

for best_design in omdb.get_best_designs():
    print(best_design.get_id())

class py_omdb.AttachedPath

__init__(arg2: Path)

property auto_insert_placeholders

Automatically detect the design directory format and replace it by a placeholder.

property path

Path to an external file.

property title

User-defined title.

class py_omdb.PyOMDB

__init__()

__init__(arg2: Path)

__init__(arg2: str)

property algorithm_info

Structure providing information about the underlying algorithm that lead to the results.

attach_file_path(file: AttachedPath)

attach_file_path(id: UUID, file: AttachedPath)

[0] Attach a path to an external file.

[1] Attach a path to an external file by id.

check_consistency()

Must be called after changes to OMDB.

clear_meta_data()

Clear the monitoring meta data.

property criteria

Criteria contained in monitoring database

property design_container

Design container contained in monitoring database

extract_important_parameter_name_list(, design_set: str]) → WStrList

get_attached_file_paths() → dict

Return a dictionay with ids as keys and attached paths as values.

get_best_designs() → PyOSDesignContainer

Get the best designs. Takes design activation state into account.

get_best_subspaces(, design_set: str]) → PyOSDesignPoint

get_build_date() → str

Return the build date of the application this database file has been created with.

get_design_duplication(arg2: PyOSDesign) → object

get_design_duplication(arg2: HID) → object

get_nominal_design() → PyOSDesign

get_parameter_names() → WStrList

get_reference_design() → PyOSDesign

get_response_names() → WStrList

get_signal_names() → WStrList

get_surrogate_info(, design_set: str]) → SurrogateInfoContainerList

get_surrogate_info_names(, design_set: str]) → WStrList

get_version() → int

Return the version of the application this database file has been created with in the format 0xMMNNPP (MM = major, NN = minor, PP = maintenance).

get_version_str() → str

Return the version of the application this database file has been created with.

get_version_suffix() → str

Return the version suffix of the application this database file has been created with.

is_design_active(design: PyOSDesign) → bool

is_design_active(design: HID) → bool

[0] Returns whether a design is active.

[1] Returns whether a design is active.

property parameter_manager

Parameter manager contained in monitoring database

remove_file_path(id: UUID)

Remove attached file path by id.

save_to_file(output: Path)

class py_omdb.PySurrogateInfo

__init__()

Raises an exception This class cannot be instantiated from Python

get_cop() → float

get_important_parameter_names() → WStrList

get_name() → str

get_params_sorted_by_cop() → WStrList

get_response_component_name() → str

get_single_cop(parameter_name: str) → float

get_testing_type() → TestingType

has_cop() → bool

has_single_cop(parameter_name: str) → bool

class py_omdb.SurrogateInfoContainerList

__contains__(arg2: object) → bool

__delitem__(arg2: object)

__getitem__(arg2: object) → object

__init__()

Raises an exception This class cannot be instantiated from Python

__iter__() → object

__len__() → int

__setitem__(arg2: object, arg3: object)

append(arg2: object)

extend(arg2: object)

class py_omdb.TestingType

Enumeration

CROSSVALIDATION = py_omdb.TestingType.CROSSVALIDATION

LEAVEONEOUT = py_omdb.TestingType.LEAVEONEOUT

py_omdb.write_cop_matrix_to_file(omdb: PyOMDB, file: Path)

Write COP matrix from omdb to file.

Connect with Ansys