Improvement before publishing (#2)

* 👷 update pypi push action

* 💡 adjusted capitalization of project description

* 📦 adjusted packaging

* 💡 docu

Author: nquetschlich

.github/workflows/deploy.yml

@@ -60,9 +60,8 @@ jobs:
         with:
           name: artifact
           path: dist
-      - uses: pypa/gh-action-pypi-publish@master
+      - uses: pypa/gh-action-pypi-publish@release/v1
         with:
-          user: __token__
           password: ${{ secrets.pypi_password }}
           skip_existing: true
           verbose: true

README.md

@@ -43,7 +43,7 @@ Here, the solution to a Travelling Salesman Problem with 4 cities can be solved
 <img src="img/tsp.png" height=200px>
 </p>
 
-MQT ProblemSolver will return the shortest path visiting all cities.
+MQT ProblemSolver will return the shortest path visiting all cities as a list.
 
 # Repository Structure
 

pyproject.toml

@@ -7,7 +7,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "mqt.problemsolver"
-description = "MQT ProblemSolver - A MQT tool for solving problems using quantum computing"
+description = "MQT ProblemSolver - A MQT tool for Solving Problems Using Quantum Computing"
 readme = "README.md"
 authors = [
     { name = "Nils Quetschlich", email = "nils.quetschlich@tum.de" },
@@ -23,7 +23,7 @@ dependencies = [
     "numpy~=1.23.3",
     "matplotlib~=3.5.1",
     "mqt.ddsim~=1.11.0",
-    "networkx~=2.8.7",
+    "networkx~=2.8.6",
     "python_tsp~=0.3.1",
 ]
 

src/mqt/problemsolver/csp_example.ipynb

@@ -29,7 +29,7 @@
     }
    ],
    "source": [
-    "from csp import CSP\n",
+    "from mqt.problemsolver.csp import CSP\n",
     "csp = CSP()\n",
     "csp.print()"
    ]
@@ -190,7 +190,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 7,
+   "execution_count": 6,
    "id": "63237a51",
    "metadata": {},
    "outputs": [

src/mqt/problemsolver/tsp_example.ipynb

@@ -10,7 +10,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 1,
+   "execution_count": 3,
    "id": "a7fa5203",
    "metadata": {},
    "outputs": [
@@ -26,7 +26,7 @@
     }
    ],
    "source": [
-    "from tsp import TSP\n",
+    "from mqt.problemsolver.tsp import TSP\n",
     "tsp = TSP()\n",
     "tsp.print()"
    ]
@@ -41,7 +41,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 10,
+   "execution_count": 4,
    "id": "ce590382",
    "metadata": {},
    "outputs": [],
@@ -64,7 +64,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 11,
+   "execution_count": 5,
    "id": "1a518ef9",
    "metadata": {},
    "outputs": [
@@ -74,7 +74,7 @@
        "['QPE']"
       ]
      },
-     "execution_count": 11,
+     "execution_count": 5,
      "metadata": {},
      "output_type": "execute_result"
     }
@@ -94,15 +94,31 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 12,
+   "execution_count": 6,
    "id": "b6a691d6",
    "metadata": {},
    "outputs": [
     {
      "name": "stdout",
      "output_type": "stream",
      "text": [
-      "Algorithm:  QPE\n",
+      "Algorithm:  QPE\n"
+     ]
+    },
+    {
+     "name": "stderr",
+     "output_type": "stream",
+     "text": [
+      "/Users/nils/miniforge3/envs/MQTProblemSolver39/lib/python3.9/site-packages/numpy/linalg/linalg.py:2154: RuntimeWarning: divide by zero encountered in det\n",
+      "  r = _umath_linalg.det(a, signature=signature)\n",
+      "/Users/nils/miniforge3/envs/MQTProblemSolver39/lib/python3.9/site-packages/numpy/linalg/linalg.py:2154: RuntimeWarning: invalid value encountered in det\n",
+      "  r = _umath_linalg.det(a, signature=signature)\n"
+     ]
+    },
+    {
+     "name": "stdout",
+     "output_type": "stream",
+     "text": [
       "[3, 1, 2, 4]\n"
      ]
     }
@@ -124,7 +140,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 13,
+   "execution_count": 7,
    "id": "6a1de27d",
    "metadata": {},
    "outputs": [
@@ -153,7 +169,7 @@
   },
   {
    "cell_type": "code",
-   "execution_count": 14,
+   "execution_count": 8,
    "id": "3435d9bc",
    "metadata": {
     "pycharm": {