desdeo 1.2__tar.gz → 2.1.0__tar.gz

desdeo-2.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 The Multiobjective Optimization Group (http://www.mit.jyu.fi/optgroup/).
+
+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.

desdeo-2.1.0/PKG-INFO

@@ -0,0 +1,186 @@
+Metadata-Version: 2.4
+Name: desdeo
+Version: 2.1.0
+Summary: DESDEO is a modular and open source framework for interactive multiobjective optimization.
+License-Expression: MIT
+License-File: LICENSE
+Keywords: optimization,decision-support,multiobjective optimization,evolutionary optimization,interactive methods
+Author: Giovanni Misitano
+Author-email: giovanni.a.misitano@jyu.fi
+Requires-Python: >=3.12,<3.14
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Requires-Dist: bayesian-optimization (>=1.0)
+Requires-Dist: coco-experiment (>=2.8.2)
+Requires-Dist: cvxpy[scip] (>=1.6.4)
+Requires-Dist: greenlet (>=3.1.1)
+Requires-Dist: gurobipy (>=12.0.0)
+Requires-Dist: moocore (>=0.1.7)
+Requires-Dist: nevergrad (>=1.0.12)
+Requires-Dist: numba (>=0.61.0)
+Requires-Dist: numpy (>=2.2.0)
+Requires-Dist: plotly (>=6.0)
+Requires-Dist: polars (==1.30)
+Requires-Dist: pyarrow (>=20.0.0)
+Requires-Dist: pydantic (>=2.9)
+Requires-Dist: pydantic-settings (>=2.9)
+Requires-Dist: pymoo (>=0.6.1.2)
+Requires-Dist: pyomo (>=6.8)
+Requires-Dist: pyparsing (>=3.0)
+Requires-Dist: requests (>=2.32.0)
+Requires-Dist: scipy (>=1.11.4)
+Requires-Dist: shap (>=0.47.0)
+Requires-Dist: sympy (>=1.0)
+Requires-Dist: tsp-solver (>=0.1)
+Requires-Dist: websockets (>=15.0.1)
+Project-URL: Bug tracker, https://github.com/industrial-optimization-group/DESDEO/issues
+Project-URL: Documentation, https://desdeo.readthedocs.io/en/latest/
+Project-URL: Homepage, https://github.com/industrial-optimization-group/DESDEO
+Project-URL: Repository, https://github.com/industrial-optimization-group/DESDEO
+Description-Content-Type: text/markdown
+
+# DESDEO: the open-source software framework for interactive multiobjective optimization
+
+ [![Discord](https://img.shields.io/discord/1382614276409266206?style=flat&label=Join%20our%20Discord&labelColor=%237289da)](https://discord.gg/uGCEgQTJyY) [![Documentation Status](https://img.shields.io/readthedocs/desdeo.svg?version=desdeo2&label=Documentation)](https://desdeo.readthedocs.io/en/latest/) ![Tests](https://img.shields.io/github/actions/workflow/status/industrial-optimization-group/DESDEO/unit_tests.yaml?branch=desdeo2&label=Tests)
+
+## Introduction
+
+DESDEO is an open-source framework for interactive multiobjective optimization
+methods. The framework contains implementations of both scalarization- and
+population-based interactive methods. There are currently no other open-source
+software frameworks that focus solely on the implementation of interactive
+multiobjective optimization methods.
+
+The mission of DESDEO is to increase awareness of the benefits of interactive
+multiobjective optimization methods, make interactive methods openly available,
+and to function as _the_ central hub for implementations of various interactive
+methods. Apart from existing methods, DESDEO offers various tools to facilitate
+the development of new methods and their application as well.  Another important
+goal of DESDEO is to answer the needs of decision makers and practitioners when
+it comes to modeling and solving real-life multiobjective optimization problems.
+
+In the bigger picture, DESDEO will be composed of three major components:
+
+1. The __core-logic__, which contains the algorithmic implementation of
+interactive methods, various tools related to multiobjective optimization, and
+means to model a variety of multiobjective optimization problems. The core-logic
+can be considered stable enough for use in research and applications.
+2. The __web-API__ (WIP), which implements a web-based application programming
+interface (API) to allow the use of the various functionalities found in
+DESDEO's core-logic through a web connection. The web-API implements also a
+database, which is a vital component for managing and enabling
+decision-support using the framework. __The
+web-API is currently under heavy development, and is subject to changes.__
+3. The __web-GUI__ (WIP), which implements a web-based interface for utilizing
+the interactive methods and tools for modeling and solving multiobjective
+optimization problems. __The web-GUI relies heavily on the web-API, and is also being actively developed currently, and therefore subject to sudden changes.__
+
+For developing and experimenting with interactive multiobjective optimization
+methods on a "grass root" level, the __core-logic__ provides the necessary
+tools.  For deploying interactive methods, the __web-API__ and the __web_GUI__
+play a central role.
+
+DESDEO is an open-source project and everybody is welcome to contribute!
+
+## Core-logic: key features
+
+DESDEO's core-logic offers various features that can facilitate the application and
+development of new interactive multiobjective optimization methods. Some
+of the key features include, but are not limited to,
+
+-   A powerful, pydantic-based, schema for modeling multiobjective optimization
+problem of various kinds. Including, analytically defined problems, data-based
+problems, surrogate-based problems, and simulation-based problems.
+Both continuous and (mixed-)integer problems are supported as well.
+-   Support to interface to many popular and powerful optimization software for
+solving multiobjective optimization problems. Including Gurobi, various solvers
+from the COIN-OR project, and nevergrad, for instance. 
+-   A wide assortment of modular software components for implementing existing
+and new interactive multiobjective optimization methods. For example, many
+scalarization functions and evolutionary operators for multiobjective
+optimization are available.
+-   An extensive documentation suitable for both newcomers to DESDEO and
+interactive multiobjective optimization in general, and seasoned veterans.
+
+## Web-API: key features
+
+DESDEO's web-API is currently under active development. Once it stabilized, its
+key features will be listed here. In the meantime, the interested user can
+follow (and contribute!) the development progress of the web-API in [this
+issue](https://github.com/industrial-optimization-group/DESDEO/issues/245).
+
+## Web-GUI: key features
+
+DESDEO's web-GUI is currently in a planning stage. Once its active development
+starts, an issue will be created for documenting its development, as is
+currently the case with the web-API.
+
+## Installation instructions
+
+DESDEO is available on PyPI to be installed via pip:
+
+```bash
+pip install desdeo
+```
+
+However, some of DESDEO's features rely on 3rd party optimizers, which should be available on your system.
+To read more on these, and on instructions on how to install the latest version of DESDEO directly from Github,
+[check out the documentation](https://desdeo.readthedocs.io/en/latest/howtoguides/installing/).
+
+## Documentation
+
+Care has been taken to make sure DESDEO is well documented, making it accessible
+to both newcomers and seasoned users alike.  [The documentation of DESDEO is
+available online.](https://desdeo.readthedocs.io/en/latest/)
+
+## Contributing
+
+As DESDEO is an open source-project, anybody is welcome to contribute.
+An extensive tutorial to get started contributing to DESDEO
+[is available in the documentation](https://desdeo.readthedocs.io/en/latest/tutorials/contributing/).
+Be sure to check it out!
+
+For additional support for contributing to DESDEO,
+be sure to check out the DESDEO channels
+in the MCDM Community's Discord server. You may join the server
+[through this invite](https://discord.gg/TgSnUmzv5M).
+
+## License
+
+DESDEO is licensed under the MIT license. For more information,
+check the `LICENSE` file.
+
+## Citing DESDEO
+
+To cite DESDEO, please include the following reference:
+
+[Misitano, G., Saini, B. S., Afsar, B., Shavazipour, B., & Miettinen, K. (2021). DESDEO: The modular and open source framework for interactive multiobjective optimization. IEEE Access, 9, 148277-148295.](https://doi.org/10.1109/ACCESS.2021.3123825)
+
+```
+@article{misitano2021desdeo,
+  title={DESDEO: The modular and open source framework for interactive multiobjective optimization},
+  author={Misitano, Giovanni and Saini, Bhupinder Singh and Afsar, Bekir and Shavazipour, Babooshka and Miettinen, Kaisa},
+  journal={IEEE Access},
+  volume={9},
+  pages={148277--148295},
+  year={2021},
+  publisher={IEEE}
+}
+```
+
+__Note__: A new article describing the latest iteration of the framework,
+also known as _DESDEO 2.0_ is currently being prepared. The content of
+this repository's master branch is considered to be _DESDEO 2.0_.
+
+## Funding
+
+Currently, DESDEO's development is partly funded by two projects granted by the
+[Research Council of Finland](https://www.aka.fi/en/). The most recent ones
+include:
+
+- DESIDES (project 355346)
+- UTOPIA (project 352784)
+- DAEMON (project 322221)
+
+

desdeo-2.1.0/README.md

@@ -0,0 +1,143 @@
+# DESDEO: the open-source software framework for interactive multiobjective optimization
+
+ [![Discord](https://img.shields.io/discord/1382614276409266206?style=flat&label=Join%20our%20Discord&labelColor=%237289da)](https://discord.gg/uGCEgQTJyY) [![Documentation Status](https://img.shields.io/readthedocs/desdeo.svg?version=desdeo2&label=Documentation)](https://desdeo.readthedocs.io/en/latest/) ![Tests](https://img.shields.io/github/actions/workflow/status/industrial-optimization-group/DESDEO/unit_tests.yaml?branch=desdeo2&label=Tests)
+
+## Introduction
+
+DESDEO is an open-source framework for interactive multiobjective optimization
+methods. The framework contains implementations of both scalarization- and
+population-based interactive methods. There are currently no other open-source
+software frameworks that focus solely on the implementation of interactive
+multiobjective optimization methods.
+
+The mission of DESDEO is to increase awareness of the benefits of interactive
+multiobjective optimization methods, make interactive methods openly available,
+and to function as _the_ central hub for implementations of various interactive
+methods. Apart from existing methods, DESDEO offers various tools to facilitate
+the development of new methods and their application as well.  Another important
+goal of DESDEO is to answer the needs of decision makers and practitioners when
+it comes to modeling and solving real-life multiobjective optimization problems.
+
+In the bigger picture, DESDEO will be composed of three major components:
+
+1. The __core-logic__, which contains the algorithmic implementation of
+interactive methods, various tools related to multiobjective optimization, and
+means to model a variety of multiobjective optimization problems. The core-logic
+can be considered stable enough for use in research and applications.
+2. The __web-API__ (WIP), which implements a web-based application programming
+interface (API) to allow the use of the various functionalities found in
+DESDEO's core-logic through a web connection. The web-API implements also a
+database, which is a vital component for managing and enabling
+decision-support using the framework. __The
+web-API is currently under heavy development, and is subject to changes.__
+3. The __web-GUI__ (WIP), which implements a web-based interface for utilizing
+the interactive methods and tools for modeling and solving multiobjective
+optimization problems. __The web-GUI relies heavily on the web-API, and is also being actively developed currently, and therefore subject to sudden changes.__
+
+For developing and experimenting with interactive multiobjective optimization
+methods on a "grass root" level, the __core-logic__ provides the necessary
+tools.  For deploying interactive methods, the __web-API__ and the __web_GUI__
+play a central role.
+
+DESDEO is an open-source project and everybody is welcome to contribute!
+
+## Core-logic: key features
+
+DESDEO's core-logic offers various features that can facilitate the application and
+development of new interactive multiobjective optimization methods. Some
+of the key features include, but are not limited to,
+
+-   A powerful, pydantic-based, schema for modeling multiobjective optimization
+problem of various kinds. Including, analytically defined problems, data-based
+problems, surrogate-based problems, and simulation-based problems.
+Both continuous and (mixed-)integer problems are supported as well.
+-   Support to interface to many popular and powerful optimization software for
+solving multiobjective optimization problems. Including Gurobi, various solvers
+from the COIN-OR project, and nevergrad, for instance. 
+-   A wide assortment of modular software components for implementing existing
+and new interactive multiobjective optimization methods. For example, many
+scalarization functions and evolutionary operators for multiobjective
+optimization are available.
+-   An extensive documentation suitable for both newcomers to DESDEO and
+interactive multiobjective optimization in general, and seasoned veterans.
+
+## Web-API: key features
+
+DESDEO's web-API is currently under active development. Once it stabilized, its
+key features will be listed here. In the meantime, the interested user can
+follow (and contribute!) the development progress of the web-API in [this
+issue](https://github.com/industrial-optimization-group/DESDEO/issues/245).
+
+## Web-GUI: key features
+
+DESDEO's web-GUI is currently in a planning stage. Once its active development
+starts, an issue will be created for documenting its development, as is
+currently the case with the web-API.
+
+## Installation instructions
+
+DESDEO is available on PyPI to be installed via pip:
+
+```bash
+pip install desdeo
+```
+
+However, some of DESDEO's features rely on 3rd party optimizers, which should be available on your system.
+To read more on these, and on instructions on how to install the latest version of DESDEO directly from Github,
+[check out the documentation](https://desdeo.readthedocs.io/en/latest/howtoguides/installing/).
+
+## Documentation
+
+Care has been taken to make sure DESDEO is well documented, making it accessible
+to both newcomers and seasoned users alike.  [The documentation of DESDEO is
+available online.](https://desdeo.readthedocs.io/en/latest/)
+
+## Contributing
+
+As DESDEO is an open source-project, anybody is welcome to contribute.
+An extensive tutorial to get started contributing to DESDEO
+[is available in the documentation](https://desdeo.readthedocs.io/en/latest/tutorials/contributing/).
+Be sure to check it out!
+
+For additional support for contributing to DESDEO,
+be sure to check out the DESDEO channels
+in the MCDM Community's Discord server. You may join the server
+[through this invite](https://discord.gg/TgSnUmzv5M).
+
+## License
+
+DESDEO is licensed under the MIT license. For more information,
+check the `LICENSE` file.
+
+## Citing DESDEO
+
+To cite DESDEO, please include the following reference:
+
+[Misitano, G., Saini, B. S., Afsar, B., Shavazipour, B., & Miettinen, K. (2021). DESDEO: The modular and open source framework for interactive multiobjective optimization. IEEE Access, 9, 148277-148295.](https://doi.org/10.1109/ACCESS.2021.3123825)
+
+```
+@article{misitano2021desdeo,
+  title={DESDEO: The modular and open source framework for interactive multiobjective optimization},
+  author={Misitano, Giovanni and Saini, Bhupinder Singh and Afsar, Bekir and Shavazipour, Babooshka and Miettinen, Kaisa},
+  journal={IEEE Access},
+  volume={9},
+  pages={148277--148295},
+  year={2021},
+  publisher={IEEE}
+}
+```
+
+__Note__: A new article describing the latest iteration of the framework,
+also known as _DESDEO 2.0_ is currently being prepared. The content of
+this repository's master branch is considered to be _DESDEO 2.0_.
+
+## Funding
+
+Currently, DESDEO's development is partly funded by two projects granted by the
+[Research Council of Finland](https://www.aka.fi/en/). The most recent ones
+include:
+
+- DESIDES (project 355346)
+- UTOPIA (project 352784)
+- DAEMON (project 322221)
+

desdeo-2.1.0/desdeo/__init__.py

@@ -0,0 +1,9 @@
+"""Configuration stuff of the DESDEO framework."""
+
+from desdeo.core import _check_executables
+
+# List of required executables
+required_executables = ["bonmin", "cbc", "ipopt"]
+
+# Check for executables when the library is imported
+_check_executables(required_executables)