Add better documentation

gkoolstra · Jan 24, 2025 · d5a95ee · d5a95ee
1 parent 05d02ec
commit d5a95ee
Show file tree

Hide file tree

Showing 8 changed files with 13,406 additions and 18,012 deletions.
diff --git a/examples/00_harmonic_well.ipynb b/examples/00_harmonic_well.ipynb
@@ -1047,7 +1047,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "neon",
+   "display_name": "eonhe",
    "language": "python",
    "name": "python3"
   },
@@ -1061,7 +1061,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.7"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,

diff --git a/examples/00_potential_inspection.ipynb b/examples/00_potential_inspection.ipynb
@@ -260,7 +260,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "neon",
+   "display_name": "eonhe",
    "language": "python",
    "name": "python3"
   },

diff --git a/examples/01_square_well.ipynb b/examples/01_square_well.ipynb
@@ -911,7 +911,7 @@
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "neon",
+   "display_name": "eonhe",
    "language": "python",
    "name": "python3"
   },
@@ -925,7 +925,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.11.3"
+   "version": "3.10.6"
   }
  },
  "nbformat": 4,

diff --git a/examples/04_time_dynamics.ipynb b/examples/04_time_dynamics.ipynb
diff --git a/examples/05_long_channel.ipynb b/examples/05_long_channel.ipynb
@@ -309,6 +309,13 @@
     "fm.plot_convergence()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "Zoom in to see wheter there are dislocations in the crystal structure"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 14,

diff --git a/examples/97_transmission_line.ipynb b/examples/97_transmission_line.ipynb
diff --git a/examples/98_electron_capacitance.ipynb b/examples/98_electron_capacitance.ipynb
@@ -37,6 +37,13 @@
     "package_versions()"
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "This Notebook calculates the eigenfrequencies and eigenvectors of electrons coupled to Symmetrically Coupled Resonators. Some of the figures in this notebook can also be found in the scientific paper https://arxiv.org/pdf/2410.19592."
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},
@@ -154,7 +161,7 @@
    "cell_type": "markdown",
    "metadata": {},
    "source": [
-    "Next, we may expand these eigenvalues small values of $\\omega_e / \\omega_0$ to arrive at the expression for the electron capacitance."
+    "Next, we may expand these eigenvalues small values of $\\omega_e / \\omega_0$ to arrive at the expression for the electron capacitance. For more information, see the Appendix of https://arxiv.org/pdf/2410.19592."
    ]
   },
   {
@@ -1541,6 +1548,13 @@
     "# If the shunt cap is much smaller than the total capacitance, alpha << 1, then the splitting is given by alpha * f0 =  cdot * f0 / c + 2 cdot "
    ]
   },
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "As noted in https://arxiv.org/pdf/2410.19592, we can also use the tail inductance to lift the degeneracy between the common and differential modes."
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 47,
@@ -1595,74 +1609,11 @@
     "plt.xlim(Ltail.min() * 1e9, Ltail.max() * 1e9)\n",
     "plt.ylim(ylims)"
    ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 52,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "array([4.87011689e+09, 3.65981498e+09])"
-      ]
-     },
-     "execution_count": 52,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "# v3 beta 1 params\n",
-    "mu0 = 4 * np.pi * 1e-7\n",
-    "l = 700e-6\n",
-    "width = 1.6e-6\n",
-    "tail_length = 425e-6\n",
-    "L_sheet = 190e-12\n",
-    "\n",
-    "corr_fac_L = 1\n",
-    "corr_fac_C = 1\n",
-    "\n",
-    "L = corr_fac_L * (mu0 * l + L_sheet * l / width)\n",
-    "L_tail = corr_fac_L * (mu0 * tail_length + L_sheet * tail_length / width)\n",
-    "\n",
-    "Cca = 2 / np.pi * corr_fac_C * (1.49e-15)\n",
-    "Ccb = 2 / np.pi * corr_fac_C * (1.49e-15)\n",
-    "Cunload = 2 / np.pi * corr_fac_C * (3.4e-15)\n",
-    "\n",
-    "Ca = 2 / np.pi * corr_fac_C * (14.48e-15) + Cca# + Cunload\n",
-    "Cb = 2 / np.pi * corr_fac_C * (14.48e-15) + Ccb# + Cunload\n",
-    "Cs = 2 / np.pi * corr_fac_C * (2.0e-15)\n",
-    "\n",
-    "evals, evecs = resonator_with_tail(L, L_tail, Ca, Cb, Cs)\n",
-    "evals"
-   ]
-  },
-  {
-   "cell_type": "code",
-   "execution_count": 229,
-   "metadata": {},
-   "outputs": [
-    {
-     "data": {
-      "text/plain": [
-       "array([[ 0.70710678,  0.70710678],\n",
-       "       [-0.70710678,  0.70710678]])"
-      ]
-     },
-     "execution_count": 229,
-     "metadata": {},
-     "output_type": "execute_result"
-    }
-   ],
-   "source": [
-    "evecs"
-   ]
   }
  ],
  "metadata": {
   "kernelspec": {
-   "display_name": "neon",
+   "display_name": "eonhe",
    "language": "python",
    "name": "python3"
   },

diff --git a/quantum_electron/schrodinger_solver.py b/quantum_electron/schrodinger_solver.py
@@ -372,6 +372,8 @@ def get_quantum_spectrum(self, coor: Optional[List[float]] = [0, 0], dxdy: List[
         Returns:
             tuple[ArrayLike, ArrayLike]: Eigenfrequencies of the first N motional modes in Hz, and a classification of the mode.
         """
+        if coor is None:
+            coor = find_minimum_location(self.potential_dict, self.voltage_dict)
 
         if not self.solved:
             self.solve_system(coor=coor, dxdy=dxdy, **solve_kwargs)