Source code for pyomo.contrib.doe

#  ___________________________________________________________________________
#
#  Pyomo: Python Optimization Modeling Objects
#  Copyright (c) 2008-2024
#  National Technology and Engineering Solutions of Sandia, LLC
#  Under the terms of Contract DE-NA0003525 with National Technology and
#  Engineering Solutions of Sandia, LLC, the U.S. Government retains certain
#  rights in this software.
#  This software is distributed under the 3-clause BSD License.
#  ___________________________________________________________________________
from .doe import DesignOfExperiments, ObjectiveLib, FiniteDifferenceStep
from .utils import rescale_FIM

# Deprecation errors for old Pyomo.DoE interface classes and structures
from pyomo.common.deprecation import deprecated

deprecation_message = (
    "Pyomo.DoE has been refactored. The current interface utilizes Experiment "
    "objects that label unknown parameters, experiment inputs, experiment outputs "
    "and measurement error. This avoids fragile string-based naming. For "
    "instructions on using the new interface, please see the Pyomo.DoE documentation "
    "`https://pyomo.readthedocs.io/en/latest/explanation/analysis/doe/doe.html`"
)


[docs] @deprecated( "Use of MeasurementVariables in Pyomo.DoE is no longer supported.", version='6.8.0' ) class MeasurementVariables:
[docs] def __init__(self, *args): raise RuntimeError(deprecation_message)
[docs] @deprecated( "Use of DesignVariables in Pyomo.DoE is no longer supported.", version='6.8.0' ) class DesignVariables:
[docs] def __init__(self, *args): raise RuntimeError(deprecation_message)
[docs] @deprecated( "Use of ModelOptionLib in Pyomo.DoE is no longer supported.", version='6.8.0' ) class ModelOptionLib:
[docs] def __init__(self, *args): raise RuntimeError(deprecation_message)