## On this page

  

 

 # py\_omdb

 Last update: 05.08.2026 

Load and inspect optiSLang OMDB files with Python:

```default
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())

```

<a id="module-py_omdb"></a>

<a id="py_omdb.AttachedPath"></a>

## *class* py\_omdb.AttachedPath

<a id="py_omdb.AttachedPath.__init__"></a>

#### \_\_init\_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path))

<a id="py_omdb.AttachedPath.auto_insert_placeholders"></a>

#### *property* auto\_insert\_placeholders

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

<a id="py_omdb.AttachedPath.path"></a>

#### *property* path

Path to an external file.

<a id="py_omdb.AttachedPath.title"></a>

#### *property* title

User-defined title.

<a id="py_omdb.PyOMDB"></a>

## *class* py\_omdb.PyOMDB

<a id="py_omdb.PyOMDB.__init__"></a>

#### \_\_init\_\_()

#### \_\_init\_\_(arg2: [Path](stdcpp_python_export.md#stdcpp_python_export.Path))

#### \_\_init\_\_(arg2: str)

<a id="py_omdb.PyOMDB.algorithm_info"></a>

#### *property* algorithm\_info

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

<a id="py_omdb.PyOMDB.attach_file_path"></a>

#### attach\_file\_path(file: [AttachedPath](#py_omdb.AttachedPath))

#### attach\_file\_path(id: [UUID](id.md#id.UUID), file: [AttachedPath](#py_omdb.AttachedPath))

\[0\] Attach a path to an external file.

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

<a id="py_omdb.PyOMDB.check_consistency"></a>

#### check\_consistency()

Must be called after changes to OMDB.

<a id="py_omdb.PyOMDB.clear_meta_data"></a>

#### clear\_meta\_data()

Clear the monitoring meta data.

<a id="py_omdb.PyOMDB.criteria"></a>

#### *property* criteria

Criteria contained in monitoring database

<a id="py_omdb.PyOMDB.design_container"></a>

#### *property* design\_container

Design container contained in monitoring database

<a id="py_omdb.PyOMDB.extract_important_parameter_name_list"></a>

#### extract\_important\_parameter\_name\_list(, design\_set: str\]) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)

<a id="py_omdb.PyOMDB.get_attached_file_paths"></a>

#### get\_attached\_file\_paths() → dict

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

<a id="py_omdb.PyOMDB.get_best_designs"></a>

#### get\_best\_designs() → [PyOSDesignContainer](py_os_design.md#py_os_design.PyOSDesignContainer)

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

<a id="py_omdb.PyOMDB.get_best_subspaces"></a>

#### get\_best\_subspaces(, design\_set: str\]) → [PyOSDesignPoint](py_os_design.md#py_os_design.PyOSDesignPoint)

<a id="py_omdb.PyOMDB.get_build_date"></a>

#### get\_build\_date() → str

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

<a id="py_omdb.PyOMDB.get_design_duplication"></a>

#### get\_design\_duplication(arg2: [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign)) → object

#### get\_design\_duplication(arg2: [HID](id.md#id.HID)) → object

<a id="py_omdb.PyOMDB.get_nominal_design"></a>

#### get\_nominal\_design() → [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign)

<a id="py_omdb.PyOMDB.get_parameter_names"></a>

#### get\_parameter\_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)

<a id="py_omdb.PyOMDB.get_reference_design"></a>

#### get\_reference\_design() → [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign)

<a id="py_omdb.PyOMDB.get_response_names"></a>

#### get\_response\_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)

<a id="py_omdb.PyOMDB.get_signal_names"></a>

#### get\_signal\_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)

<a id="py_omdb.PyOMDB.get_surrogate_info"></a>

#### get\_surrogate\_info(, design\_set: str\]) → [SurrogateInfoContainerList](#py_omdb.SurrogateInfoContainerList)

<a id="py_omdb.PyOMDB.get_surrogate_info_names"></a>

#### get\_surrogate\_info\_names(, design\_set: str\]) → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)

<a id="py_omdb.PyOMDB.get_version"></a>

#### 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).

<a id="py_omdb.PyOMDB.get_version_str"></a>

#### get\_version\_str() → str

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

<a id="py_omdb.PyOMDB.get_version_suffix"></a>

#### get\_version\_suffix() → str

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

<a id="py_omdb.PyOMDB.is_design_active"></a>

#### is\_design\_active(design: [PyOSDesign](py_os_design.md#py_os_design.PyOSDesign)) → bool

#### is\_design\_active(design: [HID](id.md#id.HID)) → bool

\[0\] Returns whether a design is active.

\[1\] Returns whether a design is active.

<a id="py_omdb.PyOMDB.parameter_manager"></a>

#### *property* parameter\_manager

Parameter manager contained in monitoring database

<a id="py_omdb.PyOMDB.remove_file_path"></a>

#### remove\_file\_path(id: [UUID](id.md#id.UUID))

Remove attached file path by id.

<a id="py_omdb.PyOMDB.save_to_file"></a>

#### save\_to\_file(output: [Path](stdcpp_python_export.md#stdcpp_python_export.Path))

<a id="py_omdb.PySurrogateInfo"></a>

## *class* py\_omdb.PySurrogateInfo

<a id="py_omdb.PySurrogateInfo.__init__"></a>

#### \_\_init\_\_()

Raises an exception This class cannot be instantiated from Python

<a id="py_omdb.PySurrogateInfo.get_cop"></a>

#### get\_cop() → float

<a id="py_omdb.PySurrogateInfo.get_important_parameter_names"></a>

#### get\_important\_parameter\_names() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)

<a id="py_omdb.PySurrogateInfo.get_name"></a>

#### get\_name() → str

<a id="py_omdb.PySurrogateInfo.get_params_sorted_by_cop"></a>

#### get\_params\_sorted\_by\_cop() → [WStrList](stdcpp_python_export.md#stdcpp_python_export.WStrList)

<a id="py_omdb.PySurrogateInfo.get_response_component_name"></a>

#### get\_response\_component\_name() → str

<a id="py_omdb.PySurrogateInfo.get_single_cop"></a>

#### get\_single\_cop(parameter\_name: str) → float

<a id="py_omdb.PySurrogateInfo.get_testing_type"></a>

#### get\_testing\_type() → [TestingType](#py_omdb.TestingType)

<a id="py_omdb.PySurrogateInfo.has_cop"></a>

#### has\_cop() → bool

<a id="py_omdb.PySurrogateInfo.has_single_cop"></a>

#### has\_single\_cop(parameter\_name: str) → bool

<a id="py_omdb.SurrogateInfoContainerList"></a>

## *class* py\_omdb.SurrogateInfoContainerList

<a id="py_omdb.SurrogateInfoContainerList.__contains__"></a>

#### \_\_contains\_\_(arg2: object) → bool

<a id="py_omdb.SurrogateInfoContainerList.__delitem__"></a>

#### \_\_delitem\_\_(arg2: object)

<a id="py_omdb.SurrogateInfoContainerList.__getitem__"></a>

#### \_\_getitem\_\_(arg2: object) → object

<a id="py_omdb.SurrogateInfoContainerList.__init__"></a>

#### \_\_init\_\_()

Raises an exception This class cannot be instantiated from Python

<a id="py_omdb.SurrogateInfoContainerList.__iter__"></a>

#### \_\_iter\_\_() → object

<a id="py_omdb.SurrogateInfoContainerList.__len__"></a>

#### \_\_len\_\_() → int

<a id="py_omdb.SurrogateInfoContainerList.__setitem__"></a>

#### \_\_setitem\_\_(arg2: object, arg3: object)

<a id="py_omdb.SurrogateInfoContainerList.append"></a>

#### append(arg2: object)

<a id="py_omdb.SurrogateInfoContainerList.extend"></a>

#### extend(arg2: object)

<a id="py_omdb.TestingType"></a>

## *class* py\_omdb.TestingType

**Enumeration**

<a id="py_omdb.TestingType.CROSSVALIDATION"></a>

#### CROSSVALIDATION *= py\_omdb.TestingType.CROSSVALIDATION*

<a id="py_omdb.TestingType.LEAVEONEOUT"></a>

#### LEAVEONEOUT *= py\_omdb.TestingType.LEAVEONEOUT*

<a id="py_omdb.write_cop_matrix_to_file"></a>

## py\_omdb.write\_cop\_matrix\_to\_file(omdb: PyOMDB, file: Path)

Write COP matrix from omdb to file.