Integrate Fermionic QAOA(FQAOA) Module and Associated Files into OpenQAOA

docs/source/index.rst

@@ -171,6 +171,18 @@ Your first RQAOA workflow
 
 rqaoa_type can take two values which select elimination strategies. The user can choose between `adaptive` or `custom`.
 
+Your first FQAOA workflow
+-------------------------
+
+.. code-block:: python
+
+   from openqaoa import FQAOA
+   fqaoa = FQAOA()
+   fqaoa.compile(qubo_problem, n_fermions)
+   fqaoa.optimize()
+
+FQAOA intrinsically imposes a hard constraint where the hamming weight is equal to n_fermions.
+
 Factory mode
 ------------
 The user is also free to directly access the source code without using the workflow API. 
@@ -303,8 +315,10 @@ Contents
    notebooks/12_testing_azure.ipynb
    notebooks/13_optimizers.ipynb
    notebooks/14_qaoa_benchmark.ipynb
-   notebooks/X_dumping_data.ipynb
    notebooks/15_Zero_Noise_Extrapolation.ipynb
+   notebooks/16_FQAOA_example.ipynb
+   notebooks/17_FQAOA_advanced_parameterization.ipynb
+   notebooks/X_dumping_data.ipynb
 
 Indices and tables
 ==================

docs/source/openqaoa_core/fqaoa.rst

@@ -0,0 +1,10 @@
+Fermionic QAOA functions
+========================
+
+A set of utility functions for FQAOA
+
+.. automodule:: openqaoa.algorithms.fqaoa.fqaoa_utils
+    :members:
+    :undoc-members:
+    :inherited-members:
+

docs/source/openqaoa_core/openqaoa_core_api.rst

@@ -6,9 +6,10 @@ OpenQAOA Core API Reference
 
    workflows
    rqaoa
+   fqaoa
    problems
    qaoaparameters
    backends
    logger_and_results
    optimizers
-   utilities
+   utilities

docs/source/openqaoa_core/workflows.rst

@@ -1,7 +1,7 @@
 Workflows
 =================================
 
-Workflows are a simple reference API to build complex quantum optimisations problems. Currently, it supports creations of `QAOA` and `Recursive QAOA` workflows.
+Workflows are a simple reference API to build complex quantum optimisations problems. Currently, it supports creations of `QAOA`, `Recursive QAOA`, `Fermionic QAOA` workflows.
 
 Workflows are designed to aid the user to focus on the optimisation problem, while delegating the construction and the execution of the specific algorithm to `OpenQAOA`
 
@@ -54,7 +54,11 @@ To choose the strategy, set the parameter ``rqaoa_type`` using the `set_rqaoa_pa
     :members:
     :undoc-members:
     :inherited-members:
-
+
+.. autoclass:: openqaoa.algorithms.fqaoa.fqaoa_workflow.FQAOA
+    :members:
+    :undoc-members:
+    :inherited-members:
 
 RQAOA Workflow Properties
 -------------------------

examples/15_Zero_Noise_Extrapolation.ipynb

@@ -5,7 +5,7 @@
    "id": "9cef204d-fca2-4dbd-abbe-91fa08242061",
    "metadata": {},
    "source": [
-    "# Zero-Noise Extrapolation: an example workflow"
+    "# 15 - Zero-Noise Extrapolation: an example workflow"
    ]
   },
   {

src/openqaoa-core/openqaoa/__init__.py

@@ -1,3 +1,3 @@
-from .algorithms import QAOA, RQAOA, QAOABenchmark
+from .algorithms import QAOA, RQAOA, FQAOA, QAOABenchmark
 from .problems import QUBO
 from .backends import create_device

src/openqaoa-core/openqaoa/algorithms/__init__.py

@@ -1,2 +1,3 @@
 from .qaoa import QAOA, QAOAResult, QAOABenchmark
 from .rqaoa import RQAOA, RQAOAResult
+from .fqaoa import FQAOA

src/openqaoa-core/openqaoa/algorithms/fqaoa/__init__.py

@@ -0,0 +1,2 @@
+from .fqaoa_workflow import FQAOA, FermiCircuitProperties, GivensRotationGateMap
+from .fqaoa_utils import *