Add warning on IQ# version to the Notebooks (#107)

microsoft · May 2, 2019 · 3a72faa · 3a72faa
1 parent 2e2fbff
commit 3a72faa
Show file tree

Hide file tree

Showing 4 changed files with 80 additions and 0 deletions.
diff --git a/BasicGates/BasicGates.ipynb b/BasicGates/BasicGates.ipynb
@@ -39,6 +39,26 @@
     "%package Microsoft.Quantum.Katas"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "> The package versions in the output of the cell above should always match. If you are running the Notebooks locally and the versions do not match, please install the IQ# version that matches the version of the `Microsoft.Quantum.Katas` package.\n",
+    "> <details>\n",
+    "> <summary><u>How to install the right IQ# version</u></summary>\n",
+    "> For example, if the version of `Microsoft.Quantum.Katas` package above is 0.5.1904.1302, the installation steps are as follows:\n",
+    ">\n",
+    "> 1. Stop the kernel.\n",
+    "> 2. Uninstall the existing version of IQ#:\n",
+    ">        dotnet tool uninstall microsoft.quantum.iqsharp -g\n",
+    "> 3. Install the matching version:\n",
+    ">        dotnet tool install microsoft.quantum.iqsharp -g --version 0.5.1904.1302\n",
+    "> 4. Reinstall the kernel:\n",
+    ">        dotnet iqsharp install\n",
+    "> 5. Restart the Notebook.\n",
+    "> </details>\n"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},

diff --git a/DeutschJozsaAlgorithm/DeutschJozsaAlgorithm.ipynb b/DeutschJozsaAlgorithm/DeutschJozsaAlgorithm.ipynb
@@ -37,6 +37,26 @@
     "%package Microsoft.Quantum.Katas"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "> The package versions in the output of the cell above should always match. If you are running the Notebooks locally and the versions do not match, please install the IQ# version that matches the version of the `Microsoft.Quantum.Katas` package.\n",
+    "> <details>\n",
+    "> <summary><u>How to install the right IQ# version</u></summary>\n",
+    "> For example, if the version of `Microsoft.Quantum.Katas` package above is 0.5.1904.1302, the installation steps are as follows:\n",
+    ">\n",
+    "> 1. Stop the kernel.\n",
+    "> 2. Uninstall the existing version of IQ#:\n",
+    ">        dotnet tool uninstall microsoft.quantum.iqsharp -g\n",
+    "> 3. Install the matching version:\n",
+    ">        dotnet tool install microsoft.quantum.iqsharp -g --version 0.5.1904.1302\n",
+    "> 4. Reinstall the kernel:\n",
+    ">        dotnet iqsharp install\n",
+    "> 5. Restart the Notebook.\n",
+    "> </details>\n"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,

diff --git a/Measurements/Measurements.ipynb b/Measurements/Measurements.ipynb
@@ -35,6 +35,26 @@
     "%package Microsoft.Quantum.Katas"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "> The package versions in the output of the cell above should always match. If you are running the Notebooks locally and the versions do not match, please install the IQ# version that matches the version of the `Microsoft.Quantum.Katas` package.\n",
+    "> <details>\n",
+    "> <summary><u>How to install the right IQ# version</u></summary>\n",
+    "> For example, if the version of `Microsoft.Quantum.Katas` package above is 0.5.1904.1302, the installation steps are as follows:\n",
+    ">\n",
+    "> 1. Stop the kernel.\n",
+    "> 2. Uninstall the existing version of IQ#:\n",
+    ">        dotnet tool uninstall microsoft.quantum.iqsharp -g\n",
+    "> 3. Install the matching version:\n",
+    ">        dotnet tool install microsoft.quantum.iqsharp -g --version 0.5.1904.1302\n",
+    "> 4. Reinstall the kernel:\n",
+    ">        dotnet iqsharp install\n",
+    "> 5. Restart the Notebook.\n",
+    "> </details>\n"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": null,

diff --git a/Superposition/Superposition.ipynb b/Superposition/Superposition.ipynb
@@ -36,6 +36,26 @@
     "%package Microsoft.Quantum.Katas"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "> The package versions in the output of the cell above should always match. If you are running the Notebooks locally and the versions do not match, please install the IQ# version that matches the version of the `Microsoft.Quantum.Katas` package.\n",
+    "> <details>\n",
+    "> <summary><u>How to install the right IQ# version</u></summary>\n",
+    "> For example, if the version of `Microsoft.Quantum.Katas` package above is 0.5.1904.1302, the installation steps are as follows:\n",
+    ">\n",
+    "> 1. Stop the kernel.\n",
+    "> 2. Uninstall the existing version of IQ#:\n",
+    ">        dotnet tool uninstall microsoft.quantum.iqsharp -g\n",
+    "> 3. Install the matching version:\n",
+    ">        dotnet tool install microsoft.quantum.iqsharp -g --version 0.5.1904.1302\n",
+    "> 4. Reinstall the kernel:\n",
+    ">        dotnet iqsharp install\n",
+    "> 5. Restart the Notebook.\n",
+    "> </details>\n"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},