engioptiqa 0.2.2__tar.gz

engioptiqa-0.2.2/.github/workflows/doc.yml

@@ -0,0 +1,21 @@
+name: doc
+
+on: push
+
+jobs:
+  generate_doc:
+    runs-on: ubuntu-latest
+    steps:
+    - uses: actions/checkout@v3
+    - name: build doc
+      run: |
+        pip install sphinx
+        sphinx-build -W -b html docs/ docs/build -j auto
+
+    - name: deploy doc
+      uses: peaceiris/actions-gh-pages@v3
+      if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./docs/build
+        force_orphan: true

engioptiqa-0.2.2/.github/workflows/test_examples.yml

@@ -0,0 +1,34 @@
+name: Test Examples
+
+on:
+  workflow_dispatch:
+  push:
+    branches: [ "*" ]
+  pull_request:
+    branches: [ "*" ]
+
+jobs:
+  run_examples:
+    runs-on: ubuntu-latest
+
+    steps:
+      - name: Check out repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+
+      - name: Run all examples
+        run: |
+          set -e
+          for f in $(find examples -name "*.py"); do
+            echo "Running $f"
+            python "$f"
+          done

engioptiqa-0.2.2/.gitignore

@@ -0,0 +1,17 @@
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+*.egg
+.eggs/
+**/__pycache__/
+
+# Distribution / packaging
+build/
+dist/
+*.egg-info/
+*.egg
+.eggs/
+
+# Test examples
+examples/rod_1d/results/

engioptiqa-0.2.2/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2023 EngiOptiQA
+
+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.

engioptiqa-0.2.2/PKG-INFO

@@ -0,0 +1,60 @@
+Metadata-Version: 2.4
+Name: engioptiqa
+Version: 0.2.2
+Summary: Engineering Optimization with Quantum Annealing
+Author-email: Fabian Key <fabian.key@tuwien.ac.at>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/EngiOptiQA/EngiOptiQA
+Project-URL: Documentation, https://engioptiqa.github.io/EngiOptiQA/
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: amplify[extra]==1.4.0
+Requires-Dist: dwave-cloud-client==0.14.0
+Requires-Dist: dwave-samplers==1.6.0
+Requires-Dist: dwave-system==1.33.0
+Requires-Dist: matplot2tikz==0.4.2
+Requires-Dist: matplotlib==3.10.7
+Requires-Dist: numpy==2.2.6
+Requires-Dist: prettytable==3.16.0
+Requires-Dist: sympy==1.14.0
+Dynamic: license-file
+
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10222617.svg)](https://doi.org/10.5281/zenodo.10222617)
+[![Test Examples](https://github.com/EngiOptiQA/EngiOptiQA/actions/workflows/test_examples.yml/badge.svg)](https://github.com/EngiOptiQA/EngiOptiQA/actions/workflows/test_examples.yml)
+
+# EngiOptiQA: Engineering Optimization with Quantum Annealing
+
+**Please note:** _EngiOptiQA_ is currently in a very early stage of development. As the project progresses, documentation, additional features, and enhancements will be added.
+
+## Overview
+_EngiOptiQA_ is a Python software library dedicated to **Engi**neering **Opti**mization with **Q**uantum **A**nnealing (QA).
+This project provides a set of tools to formulate engineering optimization problems suitable for QA.
+
+A minimal documentation can be found under [https://engioptiqa.github.io/EngiOptiQA/](https://engioptiqa.github.io/EngiOptiQA/). To learn more about the background of _EngiOptiQA_ and the implemented problem formulations, please refer to the corresponding publication [[1]](#pub1).
+
+## Citation
+
+If you use _EngiOptiQA_ in your research or work, please consider citing it using the software's [DOI](https://zenodo.org/doi/10.5281/zenodo.10222617) and the corresponding publication [Key2024](#pub1).
+
+## Quick Example
+
+Run this example for the design optimization of a rod under self-weight loading presented in [Key2024](#pub1), Section 3.2, solved using *simulated annealing (SA)*:
+
+```bash
+pip install -r requirements.txt
+python3 examples/rod_1d/design_optimization_sa.py
+```
+
+The expected $H_1$ error for the best solution is approximately $1.59 \times 10^{-2}$:
+
+```bash
+H1 Error 0.015873015873015817 0.015873015873015817
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## References
+  1. <a name="pub1"></a>Key F, Freinberger L. A Formulation of Structural Design Optimization Problems for Quantum Annealing. Mathematics. 2024; 12(3):482. [https://doi.org/10.3390/math12030482](https://doi.org/10.3390/math12030482)

engioptiqa-0.2.2/README.md

@@ -0,0 +1,38 @@
+[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.10222617.svg)](https://doi.org/10.5281/zenodo.10222617)
+[![Test Examples](https://github.com/EngiOptiQA/EngiOptiQA/actions/workflows/test_examples.yml/badge.svg)](https://github.com/EngiOptiQA/EngiOptiQA/actions/workflows/test_examples.yml)
+
+# EngiOptiQA: Engineering Optimization with Quantum Annealing
+
+**Please note:** _EngiOptiQA_ is currently in a very early stage of development. As the project progresses, documentation, additional features, and enhancements will be added.
+
+## Overview
+_EngiOptiQA_ is a Python software library dedicated to **Engi**neering **Opti**mization with **Q**uantum **A**nnealing (QA).
+This project provides a set of tools to formulate engineering optimization problems suitable for QA.
+
+A minimal documentation can be found under [https://engioptiqa.github.io/EngiOptiQA/](https://engioptiqa.github.io/EngiOptiQA/). To learn more about the background of _EngiOptiQA_ and the implemented problem formulations, please refer to the corresponding publication [[1]](#pub1).
+
+## Citation
+
+If you use _EngiOptiQA_ in your research or work, please consider citing it using the software's [DOI](https://zenodo.org/doi/10.5281/zenodo.10222617) and the corresponding publication [Key2024](#pub1).
+
+## Quick Example
+
+Run this example for the design optimization of a rod under self-weight loading presented in [Key2024](#pub1), Section 3.2, solved using *simulated annealing (SA)*:
+
+```bash
+pip install -r requirements.txt
+python3 examples/rod_1d/design_optimization_sa.py
+```
+
+The expected $H_1$ error for the best solution is approximately $1.59 \times 10^{-2}$:
+
+```bash
+H1 Error 0.015873015873015817 0.015873015873015817
+```
+
+## License
+
+This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
+
+## References
+  1. <a name="pub1"></a>Key F, Freinberger L. A Formulation of Structural Design Optimization Problems for Quantum Annealing. Mathematics. 2024; 12(3):482. [https://doi.org/10.3390/math12030482](https://doi.org/10.3390/math12030482)

engioptiqa-0.2.2/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = .
+BUILDDIR      = _build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

engioptiqa-0.2.2/docs/annealing_solvers.rst

@@ -0,0 +1,60 @@
+.. Annealing Solvers Overview
+
+============================
+Annealing Solvers
+============================
+
+.. Annealing Solver
+.. ================
+
+.. .. automodule::  engioptiqa.annealing_solvers
+
+.. Annealing Solver Class
+.. ----------------------
+
+.. .. currentmodule:: engioptiqa.annealing_solvers.annealing_solver
+
+.. .. autoclass:: AnnealingSolver
+
+
+.. Annealing Solver Methods
+.. ------------------------
+
+.. .. autosummary::
+..    :toctree: generated/
+
+Annealing Solver Amplify
+========================
+
+.. automodule::  engioptiqa.annealing_solvers.annealing_solver_amplify
+
+Annealing Solver Amplify Class
+------------------------------
+
+.. currentmodule:: engioptiqa.annealing_solvers.annealing_solver_amplify
+
+.. autoclass:: AnnealingSolverAmplify
+
+Annealing Solver Amplify Methods
+--------------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+Annealing Solver DWave
+========================
+
+.. automodule::  engioptiqa.annealing_solvers.annealing_solver_dwave
+
+Annealing Solver DWave Class
+------------------------------
+
+.. currentmodule:: engioptiqa.annealing_solvers.annealing_solver_dwave
+
+.. autoclass:: AnnealingSolverDWave
+
+Annealing Solver DWave Methods
+--------------------------------
+
+.. autosummary::
+   :toctree: generated/

engioptiqa-0.2.2/docs/conf.py

@@ -0,0 +1,32 @@
+# Configuration file for the Sphinx documentation builder.
+#
+# For the full list of built-in configuration values, see the documentation:
+# https://www.sphinx-doc.org/en/master/usage/configuration.html
+
+# -- Project information -----------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#project-information
+
+project = 'EngiOptiQA'
+copyright = '2024, Fabian Key'
+author = 'Fabian Key'
+
+# -- General configuration ---------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#general-configuration
+
+extensions = ['sphinx.ext.autodoc', 'sphinx.ext.autosummary']
+
+templates_path = ['_templates']
+exclude_patterns = ['_build', 'Thumbs.db', '.DS_Store']
+
+# Path to the root of your project, relative to the documentation source directory.
+import os
+import sys
+sys.path.insert(0, os.path.abspath('..'))
+autodoc_mock_imports = ['amplify', 'dimod', 'dwave', 'matplotlib', 'numpy', 'prettytable', 'scipy', 'sympy','matplot2tikz']
+
+
+# -- Options for HTML output -------------------------------------------------
+# https://www.sphinx-doc.org/en/master/usage/configuration.html#options-for-html-output
+
+html_theme = 'alabaster'
+#html_static_path = ['_static']

engioptiqa-0.2.2/docs/index.rst

@@ -0,0 +1,68 @@
+.. EngiOptiQA documentation master file, created by
+   sphinx-quickstart on Thu Feb 15 10:49:44 2024.
+   You can adapt this file completely to your liking, but it should at least
+   contain the root `toctree` directive.
+
+Welcome to EngiOptiQA's documentation!
+======================================
+
+*EngiOptiQA* is a software project that allows to perform **Engi**\neering **Opti**\mization with **Q**\uantum **A**\nnealing.
+
+Overview
+========
+
+*EngiOptiQA* consists of three main modules:
+
+1. :ref:`Annealing Solvers Module<solvers-module>`
+2. :ref:`Problems Module<problems-module>`
+3. :ref:`Variables Module<variables-module>`
+
+.. _solvers-module:
+
+Annealing Solvers Module
+========================
+
+This module contains solvers for *Quadratic Unconstrained Binary Optimization (QUBO)* problems.
+There are two alternative implementations based on the `Fixstars Amplify SDK <https://amplify.fixstars.com/en/sdk>`_ or the `DWave Ocean SDK <https://www.dwavesys.com/solutions-and-products/ocean/>`_, respectively.
+
+.. toctree::
+   :maxdepth: 2
+
+   annealing_solvers
+
+.. _problems-module:
+
+Problems Module
+===============
+
+This modules provides classes for setting up *QUBO* problems. 
+So far, this includes the one-dimensional problem of a rod.
+
+.. toctree::
+   :maxdepth: 2
+
+   problems
+
+.. _variables-module:
+
+Variables Module
+================
+
+This module includes classes for the representation of variables in logical qubits.
+At the moment, there exist different options for representing real-valued variables.
+
+.. toctree::
+   :maxdepth: 2
+
+   variables
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
+
+
+

engioptiqa-0.2.2/docs/make.bat

@@ -0,0 +1,35 @@
+@ECHO OFF
+
+pushd %~dp0
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+	set SPHINXBUILD=sphinx-build
+)
+set SOURCEDIR=.
+set BUILDDIR=_build
+
+%SPHINXBUILD% >NUL 2>NUL
+if errorlevel 9009 (
+	echo.
+	echo.The 'sphinx-build' command was not found. Make sure you have Sphinx
+	echo.installed, then set the SPHINXBUILD environment variable to point
+	echo.to the full path of the 'sphinx-build' executable. Alternatively you
+	echo.may add the Sphinx directory to PATH.
+	echo.
+	echo.If you don't have Sphinx installed, grab it from
+	echo.https://www.sphinx-doc.org/
+	exit /b 1
+)
+
+if "%1" == "" goto help
+
+%SPHINXBUILD% -M %1 %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+goto end
+
+:help
+%SPHINXBUILD% -M help %SOURCEDIR% %BUILDDIR% %SPHINXOPTS% %O%
+
+:end
+popd

engioptiqa-0.2.2/docs/problems.rst

@@ -0,0 +1,11 @@
+.. Problems Overview
+
+============================
+Problems
+============================
+.. toctree::
+   :maxdepth: 1
+
+   rod_1d_problems
+
+

engioptiqa-0.2.2/docs/rod_1d_problems.rst

@@ -0,0 +1,75 @@
+.. Rod (1D) Problems
+
+============================
+Rod (1D) Problems
+============================
+
+For the one-dimensional description of a rod under self-weight loading, there exist two problem formulations:
+
+1. :ref:`Structural Analysis Problem <structural-analysis-problem>`
+2. :ref:`Design Optimization Problem <design-optimization-problem>`
+
+.. Base Problem
+.. ============
+
+.. .. automodule::  engioptiqa.problems.rod_1d.base_problem
+
+.. Base Problem Class
+.. ------------------
+
+.. .. currentmodule:: engioptiqa.problems.rod_1d.base_problem
+
+.. .. autoclass:: BaseProblem
+
+
+.. Base Problem Methods
+.. --------------------
+
+.. .. autosummary::
+..    :toctree: generated/
+
+..    ~BaseProblem.set_output_path
+
+.. _structural-analysis-problem:
+
+Structural Analysis Problem
+===========================
+
+.. automodule::  engioptiqa.problems.rod_1d.structural_analysis_problem
+
+Structural Analysis Problem Class
+---------------------------------
+
+.. currentmodule:: engioptiqa.problems.rod_1d.structural_analysis_problem
+
+.. autoclass:: StructuralAnalysisProblem
+
+
+Structural Analysis Problem Methods
+-----------------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+.. _design-optimization-problem:
+
+Design Optimization Problem
+===========================
+
+.. automodule::  engioptiqa.problems.rod_1d.design_optimization_problem
+
+Design Optimization Problem Class
+---------------------------------
+
+.. currentmodule:: engioptiqa.problems.rod_1d.design_optimization_problem
+
+.. autoclass:: DesignOptimizationProblem
+
+
+Design Optimization Problem Methods
+-----------------------------------
+
+.. autosummary::
+   :toctree: generated/
+
+

engioptiqa-0.2.2/docs/variables.rst

@@ -0,0 +1,32 @@
+.. Variables Overview
+
+============================
+Variables
+============================
+
+Real Number
+============
+
+.. automodule::  engioptiqa.variables
+
+Real Number Class
+------------------
+
+.. currentmodule:: engioptiqa.variables.real_number
+
+.. autoclass:: RealNumber
+
+
+.. Real Number Attributes
+.. -----------------------
+
+.. .. autosummary::
+..    :toctree: generated/
+
+..    ~RealNumber.adj
+
+Real Number  Methods
+--------------------
+
+.. autosummary::
+   :toctree: generated/

engioptiqa-0.2.2/engioptiqa/__init__.py

@@ -0,0 +1,9 @@
+from .annealing_solvers import *
+from .problems import *
+__all__ = [
+    "AnnealingSolverAmplify",
+    "AnnealingSolverDWave",
+    "DesignOptimizationProblem",
+    "Rod1D",
+    "StructuralAnalysisProblem",
+]

engioptiqa-0.2.2/engioptiqa/annealing_solvers/__init__.py

@@ -0,0 +1,7 @@
+from .annealing_solver_amplify import AnnealingSolverAmplify
+from .annealing_solver_dwave import AnnealingSolverDWave
+
+__all__ = [
+    "AnnealingSolverAmplify",
+    "AnnealingSolverDWave"
+]

engioptiqa-0.2.2/engioptiqa/annealing_solvers/annealing_solver.py

@@ -0,0 +1,21 @@
+from abc import ABC, abstractmethod
+
+class AnnealingSolver(ABC):
+
+    def __init__(self, token_file=None, proxy=None):
+        self.proxy = proxy
+        if token_file is not None:
+            self.token = open(token_file,"r").read().replace('\n', '')
+            self.setup_client()
+
+    @abstractmethod
+    def setup_client(self):
+        pass
+
+    @abstractmethod
+    def setup_solver(self):
+        pass
+
+    @abstractmethod
+    def solve_qubo_problem(self, problem):
+        pass

engioptiqa-0.2.2/engioptiqa/annealing_solvers/annealing_solver_amplify.py

@@ -0,0 +1,55 @@
+from amplify import Solver
+from amplify.client import FixstarsClient
+from amplify.client.ocean import DWaveSamplerClient, LeapHybridSamplerClient
+
+from .annealing_solver import AnnealingSolver
+
+class AnnealingSolverAmplify(AnnealingSolver):
+    """
+        Initialize the Annealing Solver that uses the Amplify SDK.
+
+        :param client_type: The client type.
+        :param token_file: The path of the file that includes the token for the Fixstars Amplify Annealing Engine.
+    """
+    def __init__(self, client_type, token_file, proxy=None):
+        self.client_type = client_type
+        super().__init__(token_file, proxy)
+
+
+    def setup_client(self):
+
+        if self.client_type == 'fixstars':
+            self.client = FixstarsClient(token=self.token)
+        elif self.client_type == 'dwave':
+            self.client = DWaveSamplerClient(token=self.token)
+        elif self.client_type == 'dwave_hybrid':
+            self.client = LeapHybridSamplerClient(token=self.token)
+        else:
+            raise Exception('Unknown client type', self.client_type)
+        if self.proxy:
+            self.client.proxy = self.proxy
+        if self.client_type in ['dwave','dwave_hybrid']:
+            print('Available solvers:', self.client.solver_names)
+
+    
+    def setup_solver(self):
+
+        if self.client_type == 'fixstars':
+            print('Setting default timeout (ms): 800')
+            self.client.parameters.timeout = 800
+        elif self.client_type == 'dwave':
+            print('Choosing default solver: Advantage_system4.1')
+            self.client.solver = "Advantage_system4.1"
+            print('Setting default num_reads: 200')
+            self.client.parameters.num_reads = 200 
+        elif self.client_type == 'dwave_hybrid':
+            print('Choosing default solver: hybrid_binary_quadratic_model_version2')
+            self.client.solver = 'hybrid_binary_quadratic_model_version2'
+
+        self.solver = Solver(self.client)
+        print("Created solver")
+
+    def solve_qubo_problem(self, problem):
+        
+        problem.results = self.solver.solve(problem.binary_quadratic_model)
+        print('Number of solutions:', len(problem.results))