Move third_party to recirq/third_party (#361)

* Move third_party to recirq

.github/workflows/pythonpackage.yml

@@ -40,7 +40,6 @@ jobs:
           python -m pip install --upgrade pip
           python dev_tools/write-ci-requirements.py --relative-cirq-version=${{ matrix.cirq-version }} --all-extras
           pip install -r ci-requirements.txt
-          pip install -e third_party/quaff
           pip install --no-deps -e .
 
       - name: Lint with flake8

README.md

@@ -18,12 +18,6 @@ install from source:
 
 Documentation is available at https://quantumai.google/cirq/experiments.
 
-To run code relevant for the [QCQMC experiment](https://www.nature.com/articles/s41586-021-04351-z) 
-you must also install `quaff` which is vendored with recirq. From the top level of
-the recirq repository do:
-
-    pip install third_party/quaff
-
 ## See Also
 
 This code leverages [Cirq](https://github.com/quantumlib/Cirq) as a

docs/qcqmc/experimental_wavefunctions.ipynb

@@ -86,7 +86,7 @@
     "| 8896 | -1.954930 | -1.947458 | -1.913889 | -1.913068 |\n",
     "| 15000 | -1.954356 | -1.948894 | -1.913894 | -1.913082 |\n",
     "\n",
-    "Each column represents an independented partitioned shadow tomography experiment.\n"
+    "Each column represents an independent partitioned shadow tomography experiment.\n"
    ]
   },
   {

docs/qcqmc/full_workflow.ipynb

@@ -209,8 +209,7 @@
     ")\n",
     "print(f\"Reconstructed shadow wavefunction energy: {ipie_data.variational_energy}\")\n",
     "print(f\"Ideal trial wavefunction energy: {trial_wf.ansatz_energy}\")\n",
-    "print(f\"FCI energy: {trial_wf.fci_energy}\")\n",
-    "print(ipie_data)"
+    "print(f\"FCI energy: {trial_wf.fci_energy}\")"
    ]
   },
   {
@@ -372,9 +371,9 @@
    "source": [
     "# Next steps\n",
     "\n",
-    "The results presented above are far worse than reported in the paper. In practice one needs to:\n",
+    "The results presented above are worse than reported in the paper. In practice one needs to:\n",
     "\n",
-    "1. Optimize the trial wavefunction parameters\n",
+    "1. Carefully converge the trial wavefunction parameters by scanning over multiple random restarts.\n",
     "2. Converge the reconstructed shadow wavefunction with respect to: `n_cliffords`\n",
     "3. The AFQMC part of the simulations can be sped up using MPI parallelism. See [ipie](https://github.com/JoonhoLee-Group/ipie) for more information. The number of walkers should also be increased to obtain better statistics and reduce any population control biases. The number of samples (`num_blocks`) should also be increased (`ETotal_nsamp_ac` should be about 100 for statistically significant results.) "
    ]

docs/qcqmc/high_level.ipynb

@@ -301,7 +301,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.3"
+   "version": "3.10.10"
   }
  },
  "nbformat": 4,

recirq/qcqmc/blueprint.py

@@ -17,7 +17,7 @@
 import attrs
 import cirq
 import numpy as np
-import quaff
+from recirq.third_party import quaff
 
 from recirq.qcqmc import config, data, for_refactor, trial_wf
 

recirq/qcqmc/blueprint_test.py

@@ -16,7 +16,7 @@
 import cirq
 import numpy as np
 import pytest
-import quaff
+from recirq.third_party import quaff
 
 from recirq.qcqmc.blueprint import (BlueprintData, BlueprintParamsTrialWf,
                                     _get_truncated_cliffords)

recirq/qcqmc/shadow_tomography_test.py

@@ -14,7 +14,7 @@
 
 import cirq
 import numpy as np
-import quaff
+from recirq.third_party import quaff
 
 from recirq.qcqmc.bitstrings import get_bitstrings_a_b
 from recirq.qcqmc.shadow_tomography import (

recirq/third_party/__init__.py

@@ -0,0 +1,13 @@
+# Copyright 2024 Google
+#
+# Licensed under the Apache License, Version 2.0 (the "License");
+# you may not use this file except in compliance with the License.
+# You may obtain a copy of the License at
+#
+#     https://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.

third_party/quaff/quaff/__init__.py → recirq/third_party/quaff/__init__.py

@@ -1,4 +1,4 @@
-from quaff import indexing, json_serialization, linalg, random, testing
+from recirq.third_party.quaff import indexing, json_serialization, linalg, random, testing
 
 from .basis_change import BasisChangeGate, get_clearing_network, get_reversal_network
 from .comb import binom, get_inversion_number, get_num_perms_with_inversion_number
@@ -66,8 +66,8 @@
 
 
 def _register_resolver() -> None:
-    from quaff.json_resolver import json_resolver
-    from quaff.json_serialization import _internal_register_resolver
+    from recirq.third_party.quaff.json_resolver import json_resolver
+    from recirq.third_party.quaff.json_serialization import _internal_register_resolver
 
     _internal_register_resolver(json_resolver)
 

third_party/quaff/quaff/basis_change.py → recirq/third_party/quaff/basis_change.py

@@ -2,7 +2,7 @@
 
 import cirq
 import numpy as np
-from quaff import indexing, linalg, random
+from recirq.third_party.quaff import indexing, linalg, random
 
 
 class BasisChangeGate(cirq.Gate):

third_party/quaff/quaff/basis_change_test.py → recirq/third_party/quaff/basis_change_test.py

@@ -1,7 +1,7 @@
 import cirq
 import numpy as np
 import pytest
-import quaff
+from recirq.third_party import quaff
 
 
 @pytest.mark.parametrize(

third_party/quaff/quaff/comb_test.py → recirq/third_party/quaff/comb_test.py

@@ -4,7 +4,7 @@
 
 import numpy as np
 import pytest
-import quaff
+from recirq.third_party import quaff
 
 
 def test_get_num_perms_with_inversion_number():

third_party/quaff/quaff/cz_layer.py → recirq/third_party/quaff/cz_layer.py

@@ -4,7 +4,7 @@
 
 import cirq
 import numpy as np
-from quaff import basis_change, gates, indexing, linalg
+from recirq.third_party.quaff import basis_change, gates, indexing, linalg
 
 
 def get_index_range(num_qubits: int, num_steps: int, i: int):

third_party/quaff/quaff/cz_layer_test.py → recirq/third_party/quaff/cz_layer_test.py

@@ -3,7 +3,7 @@
 import cirq
 import numpy as np
 import pytest
-import quaff
+from recirq.third_party import quaff
 
 
 @pytest.mark.parametrize(

recirq/third_party/quaff/gates/__init__.py

@@ -0,0 +1,10 @@
+from recirq.third_party.quaff.gates.fhf import FHFGate
+from recirq.third_party.quaff.gates.hadamard_free import HadamardFreeGate
+from recirq.third_party.quaff.gates.parameterized import (
+    get_parameterized_truncated_clifford_ops,
+    get_parameterized_truncated_cliffords_ops,
+    get_truncated_clifford_resolver,
+    get_truncated_cliffords_resolver,
+)
+from recirq.third_party.quaff.gates.single_qubit_layer import SingleQubitLayerGate
+from recirq.third_party.quaff.gates.truncated_clifford import TruncatedCliffordGate

third_party/quaff/quaff/gates/fhf.py → recirq/third_party/quaff/gates/fhf.py

@@ -5,9 +5,9 @@
 
 import cirq
 import numpy as np
-from quaff import linalg, sampling, testing
-from quaff.gates.hadamard_free import HadamardFreeGate
-from quaff.gates.single_qubit_layer import SingleQubitLayerGate
+from recirq.third_party.quaff import linalg, sampling, testing
+from recirq.third_party.quaff.gates.hadamard_free import HadamardFreeGate
+from recirq.third_party.quaff.gates.single_qubit_layer import SingleQubitLayerGate
 
 
 def _recover_permutation(matrix: np.ndarray) -> Optional[np.ndarray]:

third_party/quaff/quaff/gates/fhf_test.py → recirq/third_party/quaff/gates/fhf_test.py

@@ -3,7 +3,7 @@
 import cirq
 import numpy as np
 import pytest
-import quaff
+from recirq.third_party import quaff
 
 
 @pytest.mark.parametrize("n, seed", ((n, quaff.random_seed()) for n in range(1, 7)))

third_party/quaff/quaff/gates/hadamard_free.py → recirq/third_party/quaff/gates/hadamard_free.py

@@ -4,7 +4,7 @@
 
 import cirq
 import numpy as np
-from quaff import indexing, linalg, random, testing
+from recirq.third_party.quaff import indexing, linalg, random, testing
 
 
 @dataclass

third_party/quaff/quaff/gates/hadamard_free_test.py → recirq/third_party/quaff/gates/hadamard_free_test.py

@@ -3,7 +3,7 @@
 import cirq
 import numpy as np
 import pytest
-import quaff
+from recirq.third_party import quaff
 
 
 def assert_hadamard_free_gate_unitary_is_good(n, gate):

third_party/quaff/quaff/gates/parameterized.py → recirq/third_party/quaff/gates/parameterized.py

@@ -2,8 +2,8 @@
 
 import cirq
 import sympy
-from quaff import cz_layer
-from quaff.gates.truncated_clifford import TruncatedCliffordGate
+from recirq.third_party.quaff import cz_layer
+from recirq.third_party.quaff.gates.truncated_clifford import TruncatedCliffordGate
 
 
 def get_truncated_clifford_resolver(

third_party/quaff/quaff/gates/parameterized_test.py → recirq/third_party/quaff/gates/parameterized_test.py

@@ -3,7 +3,7 @@
 import cirq
 import numpy as np
 import pytest
-import quaff
+from recirq.third_party import quaff
 
 
 @pytest.mark.parametrize("n, seed", ((n, quaff.random_seed()) for n in range(1, 6)))

third_party/quaff/quaff/gates/single_qubit_layer_test.py → recirq/third_party/quaff/gates/single_qubit_layer_test.py

@@ -1,7 +1,7 @@
 import cirq
 import numpy as np
 import pytest
-import quaff
+from recirq.third_party import quaff
 
 
 def test_single_qubit_layer_gate_bad():

third_party/quaff/quaff/gates/truncated_clifford.py → recirq/third_party/quaff/gates/truncated_clifford.py

@@ -4,11 +4,11 @@
 
 import cirq
 import numpy as np
-from quaff import comb, cz_layer, indexing, linalg, sampling, testing
-from quaff.gates.fhf import FHFGate
-from quaff.gates.hadamard_free import HadamardFreeGate
-from quaff.gates.single_qubit_layer import SingleQubitLayerGate
-from quaff.linalg import BooleanMatrix, BooleanVector
+from recirq.third_party.quaff import comb, cz_layer, indexing, linalg, sampling, testing
+from recirq.third_party.quaff.gates.fhf import FHFGate
+from recirq.third_party.quaff.gates.hadamard_free import HadamardFreeGate
+from recirq.third_party.quaff.gates.single_qubit_layer import SingleQubitLayerGate
+from recirq.third_party.quaff.linalg import BooleanMatrix, BooleanVector
 
 
 @dataclass(eq=True, order=True)

third_party/quaff/quaff/gates/truncated_clifford_test.py → recirq/third_party/quaff/gates/truncated_clifford_test.py

@@ -1,7 +1,7 @@
 import cirq
 import numpy as np
 import pytest
-from quaff import (
+from recirq.third_party.quaff import (
     DEFAULT_RESOLVERS,
     HadamardFreeGate,
     TruncatedCliffordGate,

third_party/quaff/quaff/indexing_test.py → recirq/third_party/quaff/indexing_test.py

@@ -2,7 +2,7 @@
 
 import numpy as np
 import pytest
-import quaff
+from recirq.third_party import quaff
 
 
 @pytest.mark.parametrize("n, big_endian", itertools.product(range(5), (0, 1)))

third_party/quaff/quaff/json_resolver.py → recirq/third_party/quaff/json_resolver.py

@@ -2,11 +2,13 @@
 
 from cirq.protocols.json_serialization import ObjectFactory
 
+from recirq.third_party import quaff
+
 
 def json_resolver(quaff_type: str) -> Optional[ObjectFactory]:
     if quaff_type.startswith("quaff."):
         return cast(
             ObjectFactory,
-            eval(f"__import__('quaff').{quaff_type.split('.', 1)[1]}", {}, {}),
+            getattr(quaff, quaff_type[6:])
         )
     return None

third_party/quaff/quaff/linalg.py → recirq/third_party/quaff/linalg.py

@@ -1,7 +1,7 @@
 from typing import Any, Callable, Iterable, Optional, Tuple, Union
 
 import numpy as np
-from quaff import indexing
+from recirq.third_party.quaff import indexing
 
 DTYPE = np.uint8
 

third_party/quaff/quaff/linalg_test.py → recirq/third_party/quaff/linalg_test.py

@@ -3,7 +3,7 @@
 import cirq
 import numpy as np
 import pytest
-import quaff
+from recirq.third_party import quaff
 
 
 @pytest.mark.parametrize(

third_party/quaff/quaff/random.py → recirq/third_party/quaff/random.py

@@ -2,7 +2,7 @@
 from typing import Optional, Tuple
 
 import numpy as np
-from quaff import indexing, linalg, sampling
+from recirq.third_party.quaff import indexing, linalg, sampling
 
 SEED = 2349230498
 RNG = np.random.default_rng(SEED)

third_party/quaff/quaff/random_test.py → recirq/third_party/quaff/random_test.py

@@ -1,6 +1,6 @@
 import numpy as np
 import pytest
-import quaff
+from recirq.third_party import quaff
 
 
 @pytest.mark.parametrize(

third_party/quaff/quaff/sampling/__init__.py → recirq/third_party/quaff/sampling/__init__.py

@@ -1,4 +1,4 @@
-from quaff import testing
+from recirq.third_party.quaff import testing
 
 from .boolean_sampler import BooleanSampler
 from .clifford_sampler import (

third_party/quaff/quaff/sampling/boolean_sampler.py → recirq/third_party/quaff/sampling/boolean_sampler.py

@@ -2,8 +2,8 @@
 from typing import Any, Iterable, Optional, Tuple
 
 import numpy as np
-from quaff import linalg, testing
-from quaff.sampling.sampler import Randomness, Sample, Sampler
+from recirq.third_party.quaff import linalg, testing
+from recirq.third_party.quaff.sampling.sampler import Randomness, Sample, Sampler
 
 
 class BooleanSampler(Sampler):

third_party/quaff/quaff/sampling/clifford_sampler.py → recirq/third_party/quaff/sampling/clifford_sampler.py

@@ -5,8 +5,8 @@
 
 import cirq
 import numpy as np
-from quaff import comb, indexing, linalg, testing
-from quaff.sampling.sampler import SingleParameterSampler
+from recirq.third_party.quaff import comb, indexing, linalg, testing
+from recirq.third_party.quaff.sampling.sampler import SingleParameterSampler
 
 QuantumMallowsSample = Tuple[Tuple[bool, ...], Tuple[int, ...]]
 QuantumMallowsRandomness = Tuple[int, ...]

third_party/quaff/quaff/sampling/invertible_matrix_sampler.py → recirq/third_party/quaff/sampling/invertible_matrix_sampler.py

@@ -3,8 +3,8 @@
 from typing import Any, Iterable, Optional, Tuple, cast
 
 import numpy as np
-from quaff import comb, indexing, linalg
-from quaff.sampling.sampler import SingleParameterSampler
+from recirq.third_party.quaff import comb, indexing, linalg
+from recirq.third_party.quaff.sampling.sampler import SingleParameterSampler
 
 MallowsSample = Tuple[int, ...]
 MallowsRandomness = Tuple[int, ...]

third_party/quaff/quaff/sampling/testing.py → recirq/third_party/quaff/sampling/testing.py

@@ -2,8 +2,8 @@
 
 import numpy as np
 import scipy.stats
-from quaff import json_serialization, random
-from quaff.testing import assert_equivalent_repr
+from recirq.third_party.quaff import json_serialization, random
+from recirq.third_party.quaff.testing import assert_equivalent_repr
 
 
 def assert_sampler_consistent(sampler_cls, *args, test_json=False, **kwargs):

third_party/quaff/quaff/testing.py → recirq/third_party/quaff/testing.py

@@ -2,7 +2,7 @@
 
 import cirq
 import numpy as np
-from quaff import linalg
+from recirq.third_party.quaff import linalg
 
 
 def assert_consistent_unitary_round_trip(num_qubits, gate_type, seed):

setup.py

@@ -58,5 +58,7 @@ def _parse_requirements(path: pathlib.Path):
           'hfvqe/molecular_data/hydrogen_chains/*/*/*',
           # Needed for ftbbl docs
           'otoc/loschmidt/tilted_square_lattice/*',
+          # Needed for qcqmc notebooks
+          'qcqmc/data/integrals/*/*',
       ]},
       )