fix docs index and ruff format many files

Author: jcmgray

docs/index_matrix.md

@@ -4,10 +4,10 @@
 :numbered:
 :maxdepth: 2
 
-matrix-basics
-matrix-generate
-matrix-calculating quantities
-matrix-solving systems
-matrix-distributed parallelism - mpi
-matrix-dynamics and evolution
+matrix/matrix-basics
+matrix/matrix-generate
+matrix/matrix-calculating quantities
+matrix/matrix-solving systems
+matrix/matrix-distributed parallelism - mpi
+matrix/matrix-dynamics and evolution
 ```

docs/index_operator.md

@@ -4,5 +4,5 @@
 :numbered:
 :maxdepth: 2
 
-operator-basics
+operator/operator-basics
 ```

docs/index_tn.md

@@ -4,13 +4,13 @@
 :numbered:
 :maxdepth: 2
 
-tensor-basics
-tensor-contraction
-tensor-drawing
-tensor-optimization
-tensor-1d
-tensor-2d
-tensor-circuit
-tensor-circuit-mps
-tensor-design
+tensor/tensor-basics
+tensor/tensor-contraction
+tensor/tensor-drawing
+tensor/tensor-optimization
+tensor/tensor-1d
+tensor/tensor-2d
+tensor/tensor-circuit
+tensor/tensor-circuit-mps
+tensor/tensor-design
 ```

quimb/__init__.py

@@ -1,6 +1,7 @@
 """
 Quantum Information for Many-Body calculations.
 """
+
 try:
     # -- Distribution mode --
     # import from _version.py generated by setuptools_scm during release

quimb/experimental/__init__.py

@@ -1,3 +1,3 @@
 """Submodule for experimental features that are likely untested and subject to
 change.
-"""
+"""

quimb/experimental/autojittn.py

@@ -3,6 +3,7 @@
 TODO:
 - [ ] check and cache on input shapes
 """
+
 import functools
 
 import autoray as ar
@@ -32,7 +33,6 @@ def _setup(self, *args, **kwargs):
 
         @self.decorator(**self.decorator_opts)
         def pyfn(*pytrees):
-
             # inject back into the skeletons
             flat = [unpack(p, skel) for p, skel in zip(pytrees, skeletons)]
             args, kwargs = ar.tree_unflatten(flat, ref_tree)

quimb/experimental/cluster_update/cluster update gen example.ipynb

@@ -53,13 +53,16 @@
     "    if method == \"cluster\":\n",
     "        gauges = gauges.copy()\n",
     "        psi.gauge_all_simple_(100, 1e-6, gauges=gauges)\n",
-    "        return psi.compute_local_expectation_cluster(\n",
-    "            ham.terms,\n",
-    "            max_distance=0,\n",
-    "            normalized=True,\n",
-    "            gauges=gauges,\n",
-    "            optimize=\"auto-hq\",\n",
-    "        ) / psi.nsites\n",
+    "        return (\n",
+    "            psi.compute_local_expectation_cluster(\n",
+    "                ham.terms,\n",
+    "                max_distance=0,\n",
+    "                normalized=True,\n",
+    "                gauges=gauges,\n",
+    "                optimize=\"auto-hq\",\n",
+    "            )\n",
+    "            / psi.nsites\n",
+    "        )\n",
     "\n",
     "    psi = psi.copy()\n",
     "    if gauges is not None:\n",
@@ -70,17 +73,21 @@
     "        return psi.compute_local_expectation_exact(ham.terms) / psi.nsites\n",
     "\n",
     "    if method == \"boundary\":\n",
-    "\n",
     "        if max_bond is None:\n",
-    "            max_bond = max(16, psi.max_bond()**2)\n",
+    "            max_bond = max(16, psi.max_bond() ** 2)\n",
     "\n",
-    "        return psi.compute_local_expectation(\n",
-    "            ham.terms,\n",
-    "            max_bond=max(16, psi.max_bond()**2),\n",
-    "            equalize_norms=1.0,\n",
-    "            normalized=True,\n",
-    "            layer_tags=None, mode=\"fit-zipup\", bsz=1,\n",
-    "        ) / psi.nsites"
+    "        return (\n",
+    "            psi.compute_local_expectation(\n",
+    "                ham.terms,\n",
+    "                max_bond=max(16, psi.max_bond() ** 2),\n",
+    "                equalize_norms=1.0,\n",
+    "                normalized=True,\n",
+    "                layer_tags=None,\n",
+    "                mode=\"fit-zipup\",\n",
+    "                bsz=1,\n",
+    "            )\n",
+    "            / psi.nsites\n",
+    "        )"
    ]
   },
   {
@@ -99,7 +106,7 @@
    "outputs": [],
    "source": [
     "D = 4\n",
-    "psi = qtn.PEPS.rand(L, L, D, seed=42, dist=\"uniform\", loc=-1/3)"
+    "psi = qtn.PEPS.rand(L, L, D, seed=42, dist=\"uniform\", loc=-1 / 3)"
    ]
   },
   {
@@ -184,8 +191,10 @@
    "source": [
     "def to_backend(x):\n",
     "    import torch\n",
+    "\n",
     "    return torch.tensor(x, dtype=torch.float32, device=\"cuda\")\n",
     "\n",
+    "\n",
     "psi.apply_to_arrays(to_backend)\n",
     "ham.apply_to_arrays(to_backend)"
    ]

quimb/experimental/cluster_update/cluster_update_old.py

@@ -1,5 +1,5 @@
-"""Implementation of arbitrary geometry wavefunction cluster update.
-"""
+"""Implementation of arbitrary geometry wavefunction cluster update."""
+
 import functools
 
 from quimb.tensor.tensor_core import ensure_dict, bonds, bonds_size, do

quimb/experimental/cluster_update/cxu.py

@@ -613,7 +613,9 @@ def compress_between_tids_bondenv_gloop_expand(
         # and and possibly gauge region
         k = self._select_tids(r, virtual=False)
         if gauges is not None:
-            k.gauge_simple_insert(gauges, power=gauge_power, smudge=gauge_smudge)
+            k.gauge_simple_insert(
+                gauges, power=gauge_power, smudge=gauge_smudge
+            )
 
         # contract the 4-index bond tensor given by this region
         k._cut_between_tids(tida, tidb, "kl", "kr")
@@ -863,4 +865,4 @@ def assemble_plot_data(self):
             "y": self.max_fit_distances,
             "yscale": "log",
         }
-        return data
+        return data