surrogates_interface 4.0.1__tar.gz

surrogates_interface-4.0.1/LICENSE

@@ -0,0 +1,25 @@
+The MIT License
+
+Copyright 2023 DTU Wind and Energy Systems
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the “Software”), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is furnished
+to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included
+in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND,
+EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
+MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
+IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
+CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
+TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
+SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+
+
+A few lines in transformers.py are taken from the scikit-learn project,
+which is licensed under the BSD 3-Clause license.

surrogates_interface-4.0.1/PKG-INFO

@@ -0,0 +1,66 @@
+Metadata-Version: 2.1
+Name: surrogates_interface
+Version: 4.0.1
+Summary: Interface for surrogate models.
+Home-page: https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface
+License: MIT
+Author: DTU Wind and Energy Systems
+Maintainer: Riccardo Riva
+Maintainer-email: ricriv@dtu.dk
+Requires-Python: >=3.9,<3.12
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Provides-Extra: all
+Provides-Extra: code-style
+Provides-Extra: docs
+Provides-Extra: om
+Provides-Extra: smt
+Provides-Extra: test
+Provides-Extra: tf
+Requires-Dist: black ; extra == "all" or extra == "code-style"
+Requires-Dist: codespell ; extra == "all" or extra == "code-style"
+Requires-Dist: flake8 ; extra == "all" or extra == "code-style"
+Requires-Dist: h5py
+Requires-Dist: isort ; extra == "all" or extra == "code-style"
+Requires-Dist: matplotlib ; extra == "all" or extra == "test" or extra == "smt"
+Requires-Dist: numpy (>=1.10.0)
+Requires-Dist: numpydoc ; extra == "all" or extra == "docs"
+Requires-Dist: openmdao (>=3.25,<4.0) ; extra == "all" or extra == "docs" or extra == "test" or extra == "om"
+Requires-Dist: pydata-sphinx-theme ; extra == "all" or extra == "docs"
+Requires-Dist: pytest ; extra == "all" or extra == "test"
+Requires-Dist: pytest-cov ; extra == "all" or extra == "test"
+Requires-Dist: pytest-testmon ; extra == "all" or extra == "test"
+Requires-Dist: scikit-learn ; extra == "all" or extra == "test" or extra == "smt" or extra == "tf"
+Requires-Dist: smt (>=2.0.1,<3.0.0) ; extra == "all" or extra == "test" or extra == "smt"
+Requires-Dist: sphinx ; extra == "all" or extra == "docs"
+Requires-Dist: sphinx-copybutton ; extra == "all" or extra == "docs"
+Requires-Dist: sphinx-sitemap ; extra == "all" or extra == "docs"
+Requires-Dist: tensorflow (>=2.10.0,<2.11) ; (platform_system == "Windows") and (extra == "all" or extra == "test" or extra == "tf")
+Requires-Dist: tensorflow (>=2.10.0,<3.0.0) ; (platform_system != "Windows") and (extra == "all" or extra == "test" or extra == "tf")
+Requires-Dist: tensorflow-cpu (>=2.10.0,<3.0.0) ; (platform_machine != "arm64" and platform_machine != "aarch64") and sys_platform == "darwin"
+Requires-Dist: tensorflow-cpu (>=2.10.0,<3.0.0) ; (platform_machine != "arm64" and platform_machine != "aarch64") and sys_platform == "linux"
+Requires-Dist: tensorflow-cpu-aws (>=2.10.0,<3.0.0) ; (platform_machine == "arm64" or platform_machine == "aarch64") and sys_platform == "linux"
+Requires-Dist: tensorflow-intel (>=2.10.0,<3.0.0) ; sys_platform == "win32"
+Requires-Dist: tensorflow-io-gcs-filesystem (<0.32.0) ; platform_system == "Windows"
+Requires-Dist: tensorflow-io-gcs-filesystem (>=0.23.1) ; platform_machine != "arm64" or platform_system != "Darwin"
+Requires-Dist: tensorflow-macos (>=2.10.0,<3.0.0) ; platform_machine == "arm64" and sys_platform == "darwin"
+Requires-Dist: tomli (>=2.0.1,<3.0.0) ; (python_version < "3.11") and (extra == "all" or extra == "test")
+Project-URL: Repository, https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface
+Description-Content-Type: text/markdown
+
+# Surrogate Models Interface
+
+[![pipeline status](https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface/badges/main/pipeline.svg)](https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface/-/commits/main)
+[![coverage report](https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface/badges/main/coverage.svg)](https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface/-/commits/main)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8282614.svg)](https://doi.org/10.5281/10.5281/zenodo.8282614)
+
+Provides a common interface to several surrogate models, including an OpenMDAO wrapper.
+
+The documentation is available at: https://surrogate-models.pages.windenergy.dtu.dk/surrogate-models-interface
+

surrogates_interface-4.0.1/README.md

@@ -0,0 +1,12 @@
+# Surrogate Models Interface
+
+[![pipeline status](https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface/badges/main/pipeline.svg)](https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface/-/commits/main)
+[![coverage report](https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface/badges/main/coverage.svg)](https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface/-/commits/main)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+[![Poetry](https://img.shields.io/endpoint?url=https://python-poetry.org/badge/v0.json)](https://python-poetry.org/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-green.svg)](https://opensource.org/licenses/MIT)
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.8282614.svg)](https://doi.org/10.5281/10.5281/zenodo.8282614)
+
+Provides a common interface to several surrogate models, including an OpenMDAO wrapper.
+
+The documentation is available at: https://surrogate-models.pages.windenergy.dtu.dk/surrogate-models-interface

surrogates_interface-4.0.1/pyproject.toml

@@ -0,0 +1,132 @@
+[tool.poetry]
+name = "surrogates_interface"
+version = "4.0.1"
+description = "Interface for surrogate models."
+authors = ["DTU Wind and Energy Systems"]
+maintainers = [
+    "Riccardo Riva <ricriv@dtu.dk>",
+	"Mads Mølgaard Pedersen <mmpe@dtu.dk>",
+]
+license = "MIT"
+readme = "README.md"
+repository = "https://gitlab.windenergy.dtu.dk/surrogate-models/surrogate-models-interface"
+
+[tool.poetry.build]
+generate-setup-file = false
+
+[tool.poetry.dependencies]
+
+python = ">=3.9,<3.12"
+numpy = ">=1.10.0"
+h5py = "*"
+black = {version="*", optional=true}
+flake8 = {version="*", optional=true}
+isort = {version="*", optional=true}
+codespell = {version="*", optional=true}
+pytest = {version="*", optional=true}
+pytest-cov = {version="*", optional=true}
+pytest-testmon = {version="*", optional=true}
+tomli = {version="^2.0.1", python="<3.11", optional=true}
+sphinx = {version="*", optional=true}
+pydata-sphinx-theme = {version="*", optional=true}
+sphinx-copybutton = {version="*", optional=true}
+sphinx-sitemap = {version="*", optional=true}
+numpydoc = {version="*", optional=true}
+matplotlib = {version="*", optional=true}
+scikit-learn = {version="*", optional=true}
+# Issue between poetry and tensorflow metadata since >=2.11
+# This is a temporary workaround
+# related to https://github.com/python-poetry/poetry/issues/8271
+# Inspired from https://github.com/tensorflow/tensorflow/blob/adb39b04e9cb116df4659a7e2de9eea27e62f25c/tensorflow/tools/pip_package/setup.py#L148-L162
+tensorflow = [
+	{version = ">=2.10.0, <2.11", markers = "platform_system == 'Windows'", optional=true },
+    {version = "^2.10.0", markers = "platform_system != 'Windows'", optional=true },
+]
+tensorflow-macos = { version = "^2.10.0", platform = "darwin", markers = "platform_machine=='arm64'", optional=true }
+tensorflow-intel = { version = "^2.10.0", platform = "win32", optional=true }
+tensorflow-cpu = [
+    { version = "^2.10.0", platform = "linux", markers = "platform_machine!='arm64' and platform_machine!='aarch64'", optional=true },
+    { version = "^2.10.0", platform = "darwin", markers = "platform_machine!='arm64' and platform_machine!='aarch64'", optional=true },]
+tensorflow-cpu-aws = { version = "^2.10.0", platform = "linux", markers = "platform_machine=='arm64' or platform_machine=='aarch64'" }
+# https://github.com/tensorflow/tensorflow/blob/adb39b04e9cb116df4659a7e2de9eea27e62f25c/tensorflow/tools/pip_package/setup.py#L107-L108
+# https://github.com/python-poetry/poetry/issues/8271#issuecomment-1697740447
+tensorflow-io-gcs-filesystem = [
+    { version = ">= 0.23.1", markers = "platform_machine!='arm64' or platform_system!='Darwin'", optional=true },
+    { version = "< 0.32.0", markers = "platform_system == 'Windows'", optional=true }
+]
+smt = {version="^2.0.1", optional=true}
+openmdao = {version="^3.25", optional=true}
+
+[tool.poetry.extras]
+all = ["black",
+       "flake8",
+	   "isort",
+	   "codespell",
+	   "pytest",
+	   "pytest-cov",
+	   "pytest-testmon",
+	   "tomli",
+	   "sphinx",
+	   "pydata-sphinx-theme",
+	   "sphinx-copybutton",
+	   "sphinx-sitemap",
+	   "numpydoc",
+	   "matplotlib",
+	   "scikit-learn",
+	   "smt",
+	   "tensorflow",
+	   "openmdao",
+	   ]
+
+docs = ["sphinx",
+	    "pydata-sphinx-theme",
+		"sphinx-copybutton",
+	    "sphinx-sitemap",
+	    "numpydoc",
+		"openmdao",
+	    ]
+
+code_style = ["black",
+              "flake8",
+	          "isort",
+	          "codespell",
+			  ]
+
+test = ["matplotlib",  # Needed by SMT.
+	    "pytest",
+	    "pytest-cov",
+	    "pytest-testmon",
+	    "tomli",
+	    "scikit-learn",
+	    "smt",
+	    "tensorflow",
+	    "openmdao",
+	    ]
+
+smt = ["matplotlib",  # Needed by SMT.
+       "scikit-learn",
+       "smt",
+	   ]
+
+tf = ["scikit-learn",
+	  "tensorflow",
+	  ]
+
+om = ["openmdao"]
+
+
+[build-system]
+build-backend = "poetry.core.masonry.api"
+requires = ["poetry-core", "numpy"]
+
+[tool.coverage.run]
+omit = ["surrogates_interface/test/*", ]
+
+[tool.coverage.report]
+fail_under = 100
+
+[tool.isort]
+profile = "black"
+
+[tool.codespell]
+ignore-words-list = "coo"

surrogates_interface-4.0.1/surrogates_interface/__init__.py

@@ -0,0 +1,3 @@
+import importlib.metadata
+
+__version__ = importlib.metadata.version(__name__)

surrogates_interface-4.0.1/surrogates_interface/domains.py

@@ -0,0 +1,107 @@
+# -*- coding: utf-8 -*-
+"""
+The classes contained in this module allow to find when a set of points is contained in the domain.
+"""
+
+from abc import ABC, abstractmethod
+
+import h5py
+import numpy as np
+
+# String type for h5py.
+H5_STR = h5py.special_dtype(vlen=str)
+
+
+class GenericDomain(ABC):
+    """Base class for all domains."""
+
+    @property
+    @abstractmethod
+    def fields(self):
+        """List of fields in hdf5 group and GenericDomain object."""
+
+    @abstractmethod
+    def in_domain(self, x):
+        """Check that the input points are inside the domain."""
+
+    def _save_h5(self, group):
+        """Save this domain to a h5py `Group`.
+
+        Parameters
+        ----------
+        group : h5py.Group
+            Group where this object will be saved.
+        """
+        group.create_dataset("type", data=self.__class__.__name__, dtype=H5_STR)
+        for f in self.fields:
+            group.create_dataset(f, data=getattr(self, f))
+
+    @classmethod
+    def _load_h5(cls, group):
+        """
+        Load this domain from a h5py `Group`.
+
+        Parameters
+        ----------
+        group : h5py.Group
+            Group where this object has been saved.
+
+        Returns
+        -------
+        obj : GenericDomain
+            The saved domain.
+        """
+        # Protected because this function should be called by SurrogateModel.load_h5.
+        return cls(*[group[f][:] for f in cls.fields])
+
+
+class BoxDomain(GenericDomain):
+    """Implements a n-dimensional box domain."""
+
+    fields = ["min", "max"]
+
+    def __init__(self, min, max):
+        """Create a new `BoxDomain`, based on the given min and max for each feature.
+
+        Parameters
+        ----------
+        min : array-like of shape (n_features)
+            Minimum for each feature.
+        max : array-like of shape (n_features)
+            Maximum for each feature.
+        """
+        self.min = np.asarray(min)
+        self.max = np.asarray(max)
+        assert np.all(np.greater_equal(self.max, self.min))
+
+    def in_domain(self, x):
+        """Check that the input points are inside the domain.
+
+        Parameters
+        ----------
+        x : array-like of shape (n_points, n_features)
+            Input points.
+
+        Returns
+        -------
+        y : array-like of shape (n_points, )
+            Array with `True` if a point is inside the domain and `False` otherwise.
+        """
+        # Test x >= min for each dimension.
+        test_min = np.greater_equal(x, self.min)
+
+        # Test x <= max for each dimension.
+        test_max = np.less_equal(x, self.max)
+
+        # Test min <= x <= max for each dimension.
+        test_minmax = np.logical_and(test_min, test_max)
+
+        # Test min <= x <= max for all dimensions.
+        return np.all(test_minmax, axis=1)
+
+    def __eq__(self, other):
+        if isinstance(other, self.__class__):
+            test_min = np.array_equal(self.min, other.min)
+            test_max = np.array_equal(self.max, other.max)
+            return test_min and test_max
+        return False