Skip to content

Commit

Permalink
docs: fix broken link (#38) (#39)
Browse files Browse the repository at this point in the history
* docs: fix broken link

* docs: fix typos

(cherry picked from commit 1fea62b)

Co-authored-by: Max Rossmannek <[email protected]>
  • Loading branch information
mergify[bot] and mrossinek authored Nov 26, 2024
1 parent 191dc81 commit 27d49ba
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 6 deletions.
6 changes: 3 additions & 3 deletions qiskit_addon_mpf/backends/quimb_circuit/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -55,10 +55,10 @@
>>> identity_factory = CircuitState
The setup of the :class:`~.quimb_circuit.CircuitEvolver` is slightly more involved. It requires a
**parametrized** :external:class:`~qiskit.circuit.QuantumCircuit` object as its input where the
**parameterized** :external:class:`~qiskit.circuit.QuantumCircuit` object as its input where the
:class:`~qiskit.circuit.Parameter` should take the place of the Trotter methods time step (``dt``).
To show how such a parametrized Trotter circuit template is constructed, we reuse the same
To show how such a parameterized Trotter circuit template is constructed, we reuse the same
Hamiltonian and second-order Suzuki-Trotter formula as in :mod:`.quimb_layers`.
>>> from qiskit.quantum_info import SparsePauliOp
Expand Down Expand Up @@ -86,7 +86,7 @@
It is **necessary** that the name of the :class:`~qiskit.circuit.Parameter` is ``dt``!
We can choose a higher order Trotter formula for the ``exact_evolver_factory``. But note, that we
must once again use a parametrized circuit, even if we immediately bind its parameter when
must once again use a parameterized circuit, even if we immediately bind its parameter when
constructing the ``partial`` function.
>>> suzuki_4 = generate_time_evolution_circuit(hamil, time=dt, synthesis=SuzukiTrotter(order=4))
Expand Down
4 changes: 2 additions & 2 deletions qiskit_addon_mpf/backends/quimb_circuit/evolver.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,8 +39,8 @@ def __init__(self, evolution_state: CircuitState, circuit: QuantumCircuit, dt: f
Args:
evolution_state: a reference to the time-evolution state.
circuit: the template circuit encoding the time-evolution of a single Trotter step. This
circuit **must** be parametrized (see :external:class:`~qiskit.circuit.Parameter` in
place of the Trotter methods time step. This parameter must be named ``dt``.
circuit **must** be parameterized (see :external:class:`~qiskit.circuit.Parameter`
in place of the Trotter methods time step. This parameter must be named ``dt``.
dt: the time step that will be used and later bound to the
:external:class:`~qiskit.circuit.Parameter` of the ``circuit`` object.
"""
Expand Down
2 changes: 1 addition & 1 deletion qiskit_addon_mpf/dynamic.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,7 +63,7 @@ class DynamicMPF:
[1]: S. Zhuk et al., Phys. Rev. Research 6, 033309 (2024).
https://journals.aps.org/prresearch/abstract/10.1103/PhysRevResearch.6.033309
[2]: N. Robertson et al., arXiv:2407.17405 (2024).
https://arxiv.org/abs/2307.17405
https://arxiv.org/abs/2407.17405
"""

def __init__(self, evolution_state: State, lhs: Evolver, rhs: Evolver) -> None:
Expand Down

0 comments on commit 27d49ba

Please sign in to comment.