Merge pull request #22 from QuantumApplicationLab/update_readme

update readme
QuantumApplicationLab · Nov 27, 2024 · 85bd21f · 85bd21f
2 parents c3bd0c4 + db26f5f
commit 85bd21f
Show file tree

Hide file tree

Showing 6 changed files with 20 additions and 57 deletions.
diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
diff --git a/README.md b/README.md
@@ -1,10 +1,10 @@
-![Platform](https://img.shields.io/badge/Platform-Linux%20%7C%20macOS%20%7C%20Windows-informational)
-[![Python](https://img.shields.io/badge/Python-3.8%20%7C%203.9%20%7C%203.10-informational)](https://www.python.org/)
-[![Qiskit](https://img.shields.io/badge/Qiskit-%E2%89%A5%200.34.2-6133BD)](https://github.com/Qiskit/qiskit)
-[![License](https://img.shields.io/github/license/qiskit-community/quantum-prototype-template?label=License)](https://github.com/qiskit-community/quantum-prototype-template/blob/main/LICENSE.txt)
+![Platform](https://img.shields.io/badge/platform-Linux-blue)
+[![Python](https://img.shields.io/badge/Python-3.8-informational)](https://www.python.org/)
+[![Qiskit](https://img.shields.io/badge/Qiskit-%E2%89%A5%200.44.2-6133BD)](https://github.com/Qiskit/qiskit)
+[![License](https://img.shields.io/github/license/quantumapplicationlab/vqls-prototype?label=License)](https://github.com/quantumapplicationlab/vqls-prototype/blob/main/LICENSE.txt)
 [![Code style: Black](https://img.shields.io/badge/Code%20style-Black-000.svg)](https://github.com/psf/black)
-[![Tests](https://github.com/qiskit-community/quantum-prototype-template/actions/workflows/test_latest_versions.yml/badge.svg)](https://github.com/qiskit-community/quantum-prototype-template/actions/workflows/test_latest_versions.yml)
-[![Coverage](https://coveralls.io/repos/github/qiskit-community/quantum-prototype-template/badge.svg?branch=main)](https://coveralls.io/github/qiskit-community/quantum-prototype-template?branch=main)
+[![Tests](https://github.com/quantumapplicationlab/vqls-prototype/actions/workflows/coverage.yml/badge.svg)](https://github.com/quantumapplicationlab/vqls-prototype/actions/workflows/coverage.yml)
+[![Coverage Status](https://coveralls.io/repos/github/QuantumApplicationLab/vqls-prototype/badge.svg?branch=main)](https://coveralls.io/github/QuantumApplicationLab/vqls-prototype?branch=main)
 
 # Variational Quantum Linear Solver Prototype
 

diff --git a/docs/conf.py b/docs/conf.py
@@ -63,7 +63,7 @@
 autoclass_content = "both"
 
 # nbsphinx options (for tutorials)
-nbsphinx_timeout = 180
+nbsphinx_timeout = 600
 nbsphinx_execute = "always"
 nbsphinx_widgets_path = ""
 exclude_patterns = ["_build", "**.ipynb_checkpoints"]
diff --git a/docs/how_tos/03_how_to_use_runtime.ipynb b/docs/how_tos/03_how_to_use_runtime.ipynb
@@ -65,7 +65,12 @@
    "metadata": {},
    "outputs": [],
    "source": [
-    "from qiskit_ibm_runtime import QiskitRuntimeService, Estimator, Session, Options\n",
+    "from qiskit_ibm_runtime import (\n",
+    "    QiskitRuntimeService,\n",
+    "    Estimator,\n",
+    "    Session,\n",
+    "    EstimatorOptions,\n",
+    ")\n",
     "from vqls_prototype import VQLS, VQLSLog\n",
     "from qiskit_algorithms import optimizers as opt\n",
     "\n",
@@ -79,11 +84,11 @@
     "    # start session\n",
     "    with Session(service=service, backend=backend) as session:\n",
     "        # options of the primitives\n",
-    "        options = Options()\n",
-    "        options.optimization_level = 3\n",
+    "        options = EstimatorOptions()\n",
+    "        options.resilience_level = 0\n",
     "\n",
     "        # estimator\n",
-    "        estimator = Estimator(session=session, options=options)\n",
+    "        estimator = Estimator(mode=session, options=options)\n",
     "\n",
     "        # log\n",
     "        log = VQLSLog([], [])\n",

diff --git a/docs/tutorials/vqls.ipynb b/docs/tutorials/vqls.ipynb
@@ -301,7 +301,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "qalcore",
+   "display_name": "vitens_wntr_1",
    "language": "python",
    "name": "python3"
   },
@@ -315,14 +315,9 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.8.13"
+   "version": "3.9.0"
   },
-  "orig_nbformat": 4,
-  "vscode": {
-   "interpreter": {
-    "hash": "390591a6667b05d6f83558ed597f55be1305d4de992db830679d199a6a0e520c"
-   }
-  }
+  "orig_nbformat": 4
  },
  "nbformat": 4,
  "nbformat_minor": 2

diff --git a/tox.ini b/tox.ini
@@ -23,7 +23,7 @@ envdir = .tox/lint
 extras = dev
 commands =
   black --check .
-  pylint -rn vqls_prototype tests --disable=C0200,C0103,W4902,C0116,E1101,C0103,C0115,R0902,R0913,R0903,R0914,C0412,W0621,W0246,C0114,R0801
+  pylint -rn vqls_prototype tests --disable=C0200,C0103,W4902,C0116,E1101,C0103,C0115,R0902,R0913,R0903,R0914,C0412,W0621,W0246,C0114,R0801,R0917
   nbqa pylint -rn docs/ --disable=C0200,C0103,W4902,C0116,E1101,C0103,C0115,R0902,R0913,R0903,R0914,C0412,W0621,W0246,C0114,C0413,C0411,W0212,W0611,R0801,E0401,W0702
   mypy .