py_omdb

    Introduction

    Load and inspect optiSLang OMDB files with Python:

    Example Code 
    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())

    Enums

    TestingType
    CROSSVALIDATION
    LEAVEONEOUT

    Functions

    write_cop_matrix_to_file

    write_cop_matrix_to_file( (PyOMDB)omdb, (Path)file [, (bool)condensed=False]) -> None


    Write COP matrix from omdb to file.

    WriteCoPMatrixToFile

    deprecated

    Classes

    AttachedPath

    Constructors

    Properties

    • () auto_insert_placeholders
      Automatically detect the design directory format and replace it by a placeholder.
    • () path
      Path to an external file.
    • () title
      User-defined title.

    PyOMDB

    Constructors

    Properties

    • (AlgorithmInfo) algorithm_info
      Structure providing information about the underlying algorithm that lead to the results.
    • Criteria contained in monitoring database
    • (PyOSDesignContainer) design_container
      Design container contained in monitoring database
    • (PyParameterManager) parameter_manager
      Parameter manager contained in monitoring database

    Methods

    attach_file_path

    attach_file_path( (AttachedPath)file) -> None


    Attach a path to an external file.

    ----

    attach_file_path( (id.html#UUID" class="pythontype">UUID)id, (AttachedPath)file) -> None


    Attach a path to an external file by id.

    check_consistency

    check_consistency() -> None


    Must be called after changes to OMDB.

    CheckConsistency deprecated

    extract_important_parameter_name_list

    extract_important_parameter_name_list( [, (str)design_set]) -> WStrList



    ExtractImportantParameterNameList deprecated

    get_attached_file_paths

    get_attached_file_paths() -> dict


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

    get_best_designs

    get_best_designs() -> PyOSDesignContainer


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

    get_best_subspaces

    get_best_subspaces( [, (str)design_set]) -> PyOSDesignPoint



    get_build_date

    get_build_date() -> str


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

    get_design_duplication

    get_design_duplication( (PyOSDesign)arg2) -> object



    ----

    get_design_duplication( (HID)arg2) -> object



    get_nominal_design

    get_nominal_design() -> PyOSDesign



    get_parameter_names

    get_parameter_names() -> WStrList



    get_reference_design

    get_reference_design() -> PyOSDesign



    get_response_names

    get_response_names() -> WStrList



    get_surrogate_info

    get_surrogate_info( [, (str)design_set]) -> SurrogateInfoContainerList



    get_surrogate_info_names

    get_surrogate_info_names( [, (str)design_set]) -> WStrList



    get_version

    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

    get_version_str() -> str


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

    get_version_suffix

    get_version_suffix() -> str


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

    GetBestSubspaces deprecated

    GetNominalDesign deprecated

    GetParameterNames deprecated

    GetReferenceDesign deprecated

    GetResponseNames deprecated

    GetSurrogateInfoNames deprecated

    GetSurrogateInfos deprecated

    is_design_active

    is_design_active( (PyOSDesign)design) -> bool


    Returns whether a design is active.

    ----

    is_design_active( (HID)design) -> bool


    Returns whether a design is active.

    remove_file_path

    remove_file_path( (id.html#UUID" class="pythontype">UUID)id) -> None


    Remove attached file path by id.

    save_to_file

    save_to_file( (Path)output) -> None



    SaveToFile deprecated

    PySurrogateInfo

    Constructors

    Methods

    get_cop

    get_cop() -> float



    get_important_parameter_names

    get_important_parameter_names() -> WStrList



    get_name

    get_name() -> str



    get_params_sorted_by_cop

    get_params_sorted_by_cop() -> WStrList



    get_response_component_name

    get_response_component_name() -> str



    get_single_cop

    get_single_cop( (str)parameter_name) -> float



    get_testing_type

    get_testing_type() -> TestingType



    GetCoP deprecated

    GetImportantParameterNames deprecated

    GetName deprecated

    GetParamsSortedByCoP deprecated

    GetSingleCoP deprecated

    GetTestingType deprecated

    has_cop

    has_cop() -> bool



    has_single_cop

    has_single_cop( (str)parameter_name) -> bool



    HasCoP deprecated

    HasSingleCoP deprecated

    SurrogateInfoContainerList

    iterable has_length itemsetter itemgetter

    Constructors

    Methods

    append

    append( (object)arg2) -> None



    extend

    extend( (object)arg2) -> None