iwopy 0.1.8__tar.gz → 0.2__tar.gz

{iwopy-0.1.8/iwopy.egg-info → iwopy-0.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: iwopy
-Version: 0.1.8
+Version: 0.2
 Summary: Fraunhofer IWES optimization tools in Python
 Home-page: https://github.com/FraunhoferIWES/iwopy
 Author: Fraunhofer IWES
@@ -23,18 +23,26 @@ Requires-Dist: matplotlib
 Provides-Extra: test
 Requires-Dist: flake8; extra == "test"
 Requires-Dist: pytest; extra == "test"
-Requires-Dist: pymoo>=0.6; extra == "test"
 Requires-Dist: pygmo; extra == "test"
+Requires-Dist: pymoo>=0.6; extra == "test"
 Provides-Extra: doc
 Requires-Dist: sphinx; extra == "doc"
-Requires-Dist: sphinx_rtd_theme; extra == "doc"
-Requires-Dist: sphinxcontrib-email; extra == "doc"
+Requires-Dist: sphinx-immaterial; extra == "doc"
 Requires-Dist: nbsphinx; extra == "doc"
 Requires-Dist: ipykernel; extra == "doc"
+Requires-Dist: ipywidgets; extra == "doc"
 Requires-Dist: m2r2; extra == "doc"
 Provides-Extra: all
+Requires-Dist: flake8; extra == "all"
+Requires-Dist: pytest; extra == "all"
 Requires-Dist: pygmo; extra == "all"
 Requires-Dist: pymoo>=0.6; extra == "all"
+Requires-Dist: sphinx; extra == "all"
+Requires-Dist: sphinx-immaterial; extra == "all"
+Requires-Dist: nbsphinx; extra == "all"
+Requires-Dist: ipykernel; extra == "all"
+Requires-Dist: ipywidgets; extra == "all"
+Requires-Dist: m2r2; extra == "all"
 Provides-Extra: scripts
 
 # iwopy
@@ -49,6 +57,7 @@ The `iwopy` package is in fact a meta package that provides interfaces to other
 
 - [pymoo](https://pymoo.org/index.html)
 - [pygmo](https://esa.github.io/pygmo2/index.html)
+- [scipy](https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html)
 - (more to come with future versions)
 
 `iwopy` can thus be understood as an attempt to provide *the best of all worlds* when it comes to solving optimization problems with Python. This has not yet been achieved, since above list of accessable optimization packages is obviously incomplete, but it's a start. All the credit for implementing the invoked optimizers goes to the original package providers.
@@ -141,6 +150,20 @@ Then you can either install from this directory via
 pip install -e .
 ```
 
+## Testing
+
+For testing, please clone the repository and install the required dependencies:
+```console
+git clone https://github.com/FraunhoferIWES/iwopy.git
+cd iwopy
+pip install -e .[test]
+```
+
+The tests are then run by
+```console
+pytest tests
+```
+
 ## Contributing
 
 1. Fork _iwopy_ on _github_.

{iwopy-0.1.8 → iwopy-0.2}/README.md

@@ -10,6 +10,7 @@ The `iwopy` package is in fact a meta package that provides interfaces to other
 
 - [pymoo](https://pymoo.org/index.html)
 - [pygmo](https://esa.github.io/pygmo2/index.html)
+- [scipy](https://docs.scipy.org/doc/scipy/reference/generated/scipy.optimize.minimize.html)
 - (more to come with future versions)
 
 `iwopy` can thus be understood as an attempt to provide *the best of all worlds* when it comes to solving optimization problems with Python. This has not yet been achieved, since above list of accessable optimization packages is obviously incomplete, but it's a start. All the credit for implementing the invoked optimizers goes to the original package providers.
@@ -102,6 +103,20 @@ Then you can either install from this directory via
 pip install -e .
 ```
 
+## Testing
+
+For testing, please clone the repository and install the required dependencies:
+```console
+git clone https://github.com/FraunhoferIWES/iwopy.git
+cd iwopy
+pip install -e .[test]
+```
+
+The tests are then run by
+```console
+pytest tests
+```
+
 ## Contributing
 
 1. Fork _iwopy_ on _github_.

iwopy-0.2/iwopy/VERSION

@@ -0,0 +1 @@
+0.2

{iwopy-0.1.8 → iwopy-0.2}/iwopy/__init__.py

@@ -1,3 +1,8 @@
+"""
+Fraunhofer IWES optimization tools in Python
+    
+"""
+
 from .core import Problem, Objective, Constraint, Memory
 from .wrappers import (
     ProblemWrapper,
@@ -13,6 +18,11 @@ from . import interfaces
 from . import benchmarks
 from . import optimizers
 
-from importlib.resources import read_text
+try:
+    from importlib.resources import files
+
+    __version__ = files(__package__).joinpath("VERSION").read_text()
+except ImportError:
+    from importlib.resources import read_text
 
-__version__ = read_text(__package__, "VERSION")
+    __version__ = read_text(__package__, "VERSION")

iwopy-0.2/iwopy/benchmarks/branin/__init__.py

@@ -0,0 +1 @@
+from .branin import BraninObjective, BraninProblem

{iwopy-0.1.8/iwopy/benchmarks → iwopy-0.2/iwopy/benchmarks/branin}/branin.py

@@ -31,21 +31,26 @@ class BraninObjective(SimpleObjective):
 
     f(x,y) = 0.397887
 
-    Parameters
-    ----------
-    problem: iwopy.Problem
-        The underlying optimization problem
-    ana_deriv : bool
-        Switch for analytical derivatives
-    name: str
-        The function name
+    :group: benchmarks.branin
 
     """
 
     def __init__(self, problem, ana_deriv=False, name="f"):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        problem: iwopy.Problem
+            The underlying optimization problem
+        ana_deriv: bool
+            Switch for analytical derivatives
+        name: str
+            The function name
+
+        """
         super().__init__(problem, name, n_components=1, has_ana_derivs=ana_deriv)
 
-        # Parameters of branin function,
         # (a, b, c, r, s, t)
         self._pars = (
             1,
@@ -82,24 +87,29 @@ class BraninProblem(SimpleProblem):
     """
     Problem definition of benchmark function Branin.
 
-    Parameters
-    ----------
-    name : str
-        The name of the problem
-    ana_deriv : bool
-        Switch for analytical derivatives
-    initial_values : list of float
-        The initial values
-
     Attributes
     ----------
-    initial_values : list of float
+    initial_values: list of float
         The initial values
 
+    :group: benchmarks.branin
+
     """
 
     def __init__(self, name="branin", initial_values=[1.0, 1.0], ana_deriv=False):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        name: str
+            The name of the problem
+        ana_deriv: bool
+            Switch for analytical derivatives
+        initial_values: list of float
+            The initial values
 
+        """
         super().__init__(
             name,
             float_vars={"x": initial_values[0], "y": initial_values[1]},

iwopy-0.2/iwopy/benchmarks/rosenbrock/__init__.py

@@ -0,0 +1 @@
+from .rosenbrock import RosenbrockObjective, RosenbrockProblem

{iwopy-0.1.8/iwopy/benchmarks → iwopy-0.2/iwopy/benchmarks/rosenbrock}/rosenbrock.py

@@ -1,5 +1,3 @@
-import numpy as np
-
 from iwopy import SimpleProblem, SimpleObjective
 
 
@@ -25,16 +23,7 @@ class RosenbrockObjective(SimpleObjective):
 
     f(x,y) = 0
 
-    Parameters
-    ----------
-    problem : iwopy.Problem
-        The underlying optimization problem
-    pars : tuple
-        The a, b parameters
-    ana_deriv : bool
-        Switch for analytical derivatives
-    name : str
-        The function name
+    :group: benchmarks.rosenbrock
 
     """
 
@@ -45,9 +34,23 @@ class RosenbrockObjective(SimpleObjective):
         ana_deriv=False,
         name="f",
     ):
+        """
+        Construtor
+
+        Parameters
+        ----------
+        problem: iwopy.Problem
+            The underlying optimization problem
+        pars: tuple
+            The a, b parameters
+        ana_deriv: bool
+            Switch for analytical derivatives
+        name: str
+            The function name
+
+        """
         super().__init__(problem, name, n_components=1, has_ana_derivs=ana_deriv)
 
-        # Parameters of branin function,
         # (a, b)
         self._pars = pars
 
@@ -73,24 +76,13 @@ class RosenbrockProblem(SimpleProblem):
     """
     Problem definition of benchmark function Rosenbrock.
 
-    Parameters
-    ----------
-    lower : list of float
-        The minimal variable values
-    upper : list of float
-        The maximal variable values
-    initial : list of float
-        The initial values
-    ana_deriv : bool
-        Switch for analytical derivatives
-    name : str
-        The name of the problem
-
     Attributes
     ----------
-    initial_values : list of float
+    initial_values: list of float
         The initial values
 
+    :group: benchmarks.rosenbrock
+
     """
 
     def __init__(
@@ -101,7 +93,23 @@ class RosenbrockProblem(SimpleProblem):
         ana_deriv=False,
         name="rosenbrock",
     ):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        lower: list of float
+            The minimal variable values
+        upper: list of float
+            The maximal variable values
+        initial: list of float
+            The initial values
+        ana_deriv: bool
+            Switch for analytical derivatives
+        name: str
+            The name of the problem
 
+        """
         super().__init__(
             name,
             float_vars={"x": initial[0], "y": initial[1]},

{iwopy-0.1.8 → iwopy-0.2}/iwopy/core/base.py

@@ -2,19 +2,25 @@ class Base:
     """
     Generic base for various iwopy objects.
 
-    Parameters
-    ----------
-    name : str
-        The name
-
     Attributes
     ----------
-    name : str
+    name: str
         The name
 
+    :group: core
+
     """
 
     def __init__(self, name):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        name: str
+            The name
+
+        """
         self.name = name
         self._initialized = False
         if name is None:
@@ -53,7 +59,7 @@ class Base:
 
         Parameters
         ----------
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         """
@@ -65,7 +71,7 @@ class Base:
 
         Parameters
         ----------
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         """

{iwopy-0.1.8 → iwopy-0.2}/iwopy/core/constraint.py

@@ -8,19 +8,25 @@ class Constraint(OptFunction):
     Abstract base class for optimization
     constraints.
 
-    Parameters
-    ----------
-    tol : float
-        The tolerance for constraint violations
-
     Attributes
     ----------
-    tol : float
+    tol: float
         The tolerance for constraint violations
 
+    :group: core
+
     """
 
     def __init__(self, *args, tol=1e-5, **kwargs):
+        """
+        Constructor
+
+        Parameters
+        ----------
+        tol: float
+            The tolerance for constraint violations
+
+        """
         super().__init__(*args, **kwargs)
         self.tol = tol
 
@@ -32,9 +38,9 @@ class Constraint(OptFunction):
 
         Returns
         -------
-        min : np.array
+        min: np.array
             The lower bounds, shape: (n_components,)
-        max : np.array
+        max: np.array
             The upper bounds, shape: (n_components,)
 
         """
@@ -50,13 +56,13 @@ class Constraint(OptFunction):
 
         Parameters
         ----------
-        constraint_values : np.array
+        constraint_values: np.array
             The constraint values, shape: (n_components,)
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         Returns
-        values : np.array
+        values: np.array
         -------
             The boolean result, shape: (n_components,)
 
@@ -82,14 +88,14 @@ class Constraint(OptFunction):
 
         Parameters
         ----------
-        constraint_values : np.array
+        constraint_values: np.array
             The constraint values, shape: (n_pop, n_components,)
-        verbosity : int
+        verbosity: int
             The verbosity level, 0 = silent
 
         Returns
         -------
-        values : np.array
+        values: np.array
             The boolean result, shape: (n_pop, n_components)
 
         """