diff --git a/docs/src/examples/quantum1d/5.haldane-spt/index.md b/docs/src/examples/quantum1d/5.haldane-spt/index.md index 7fe114d77..6f95d9769 100644 --- a/docs/src/examples/quantum1d/5.haldane-spt/index.md +++ b/docs/src/examples/quantum1d/5.haldane-spt/index.md @@ -117,7 +117,7 @@ SPT phase has a dominant value that is not in the trivial sector, which leads to non-injective MPS. Finally, the entanglement spectrum of the wrong SPT phase will show degeneracies of all -singular values, which can again be attributed to an attempt to mimick the spectrum of the +singular values, which can again be attributed to an attempt to mimic the spectrum of the right SPT phase. ````julia @@ -196,4 +196,3 @@ S_plus = 1.5450323530571919 --- *This page was generated using [Literate.jl](https://github.com/fredrikekre/Literate.jl).* - diff --git a/docs/src/examples/quantum1d/5.haldane-spt/main.ipynb b/docs/src/examples/quantum1d/5.haldane-spt/main.ipynb index b7906ad8d..a5c803849 100644 --- a/docs/src/examples/quantum1d/5.haldane-spt/main.ipynb +++ b/docs/src/examples/quantum1d/5.haldane-spt/main.ipynb @@ -123,7 +123,7 @@ "non-injective MPS.\n", "\n", "Finally, the entanglement spectrum of the wrong SPT phase will show degeneracies of all\n", - "singular values, which can again be attributed to an attempt to mimick the spectrum of the\n", + "singular values, which can again be attributed to an attempt to mimic the spectrum of the\n", "right SPT phase." ] }, @@ -213,4 +213,4 @@ }, "nbformat": 4, "nbformat_minor": 3 -} \ No newline at end of file +} diff --git a/docs/src/examples/quantum1d/8.bose-hubbard/index.md b/docs/src/examples/quantum1d/8.bose-hubbard/index.md index bc1bdcd1a..9342b7f9f 100644 --- a/docs/src/examples/quantum1d/8.bose-hubbard/index.md +++ b/docs/src/examples/quantum1d/8.bose-hubbard/index.md @@ -274,7 +274,7 @@ scatter!( ![](figure-3.png) This shows that any finite bond dimension MPS necessarily breaks the symmetry of the system, -forming a Bose-Einstein condensate which introduces erraneous long-distance behaviour of +forming a Bose-Einstein condensate which introduces erroneous long-distance behaviour of correlation functions. In case of finite bond dimension, it is thus reasonable to associate the finite expectation value of the field operator to the 'quasicondensate' density of the system which vanishes as $D \to \infty$. @@ -466,4 +466,3 @@ using what we have learnt in this tutorial. --- *This page was generated using [Literate.jl](https://github.com/fredrikekre/Literate.jl).* - diff --git a/docs/src/man/parallelism.md b/docs/src/man/parallelism.md index 75bf42cc6..683be061c 100644 --- a/docs/src/man/parallelism.md +++ b/docs/src/man/parallelism.md @@ -13,7 +13,7 @@ overall performance. A lot of the confusion stems from the fact that the BLAS threading behaviour is not consistent between different vendors. Additionally, performance behaviour is severely dependent on hardware, the specifics of the problem, and the availability of other resources -such as total memory, or memory bandwith. This means that there is no one size fits all +such as total memory, or memory bandwidth. This means that there is no one size fits all solution, and that you will have to experiment with the settings to get optimal performance. Nevertheless, there are some general guidelines that can be followed, which seem to at least work well in most cases. @@ -45,9 +45,9 @@ julia> using ThreadPinning; threadinfo(; blas=true, hints=true) System: 8 cores (2-way SMT), 1 sockets, 1 NUMA domains -| 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15 | +| 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15 | -# = Julia thread, # = HT, # = Julia thread on HT, | = Socket seperator +# = Julia thread, # = HT, # = Julia thread on HT, | = Socket separator Julia threads: 4 ├ Occupied CPU-threads: 4 @@ -62,9 +62,9 @@ julia> using MKL; threadinfo(; blas=true, hints=true) System: 8 cores (2-way SMT), 1 sockets, 1 NUMA domains -| 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15 | +| 0,1,2,3,4,5,6,7,8,9,10,11,12,13,14,15 | -# = Julia thread, # = HT, # = Julia thread on HT, | = Socket seperator +# = Julia thread, # = HT, # = Julia thread on HT, | = Socket separator Julia threads: 4 ├ Occupied CPU-threads: 4 @@ -95,7 +95,7 @@ MPSKit.Defaults.set_scheduler!(:greedy) # multithreading with greedy load-balanc MPSKit.Defaults.set_scheduler!(:dynamic) # default: multithreading with some load-balancing ``` -For further reference on the available schedulers and finer control, please refer to the +For further reference on the available schedulers and finer control, please refer to the [`OhMyThreads.jl` documentation](https://juliafolds2.github.io/OhMyThreads.jl/stable/) ## TensorKit multithreading diff --git a/examples/quantum1d/5.haldane-spt/main.jl b/examples/quantum1d/5.haldane-spt/main.jl index 528fd3067..937228e6d 100644 --- a/examples/quantum1d/5.haldane-spt/main.jl +++ b/examples/quantum1d/5.haldane-spt/main.jl @@ -98,7 +98,7 @@ SPT phase has a dominant value that is not in the trivial sector, which leads to non-injective MPS. Finally, the entanglement spectrum of the wrong SPT phase will show degeneracies of all -singular values, which can again be attributed to an attempt to mimick the spectrum of the +singular values, which can again be attributed to an attempt to mimic the spectrum of the right SPT phase. """ diff --git a/examples/quantum1d/8.bose-hubbard/main.jl b/examples/quantum1d/8.bose-hubbard/main.jl index 571107698..679649303 100644 --- a/examples/quantum1d/8.bose-hubbard/main.jl +++ b/examples/quantum1d/8.bose-hubbard/main.jl @@ -228,7 +228,7 @@ scatter!( md""" This shows that any finite bond dimension MPS necessarily breaks the symmetry of the system, -forming a Bose-Einstein condensate which introduces erraneous long-distance behaviour of +forming a Bose-Einstein condensate which introduces erroneous long-distance behaviour of correlation functions. In case of finite bond dimension, it is thus reasonable to associate the finite expectation value of the field operator to the 'quasicondensate' density of the system which vanishes as $D \to \infty$. @@ -242,14 +242,14 @@ Fourier transform of the single-particle density matrix. Starting from the defin momentum occupation operators: ```math -\hat{a}_k = \frac{1}{\sqrt{L}} \sum_j e^{-ikj} \hat{a}_j, \qquad +\hat{a}_k = \frac{1}{\sqrt{L}} \sum_j e^{-ikj} \hat{a}_j, \qquad \hat{a}_k^\dagger = \frac{1}{\sqrt{L}} \sum_{j'} e^{ikj'} \hat{a}_{j'}^\dagger ``` the momentum distribution is ```math -\langle \hat{n}_k \rangle = \langle \hat{a}_k^\dagger \hat{a}_k \rangle +\langle \hat{n}_k \rangle = \langle \hat{a}_k^\dagger \hat{a}_k \rangle = \frac{1}{L} \sum_{j',j} e^{ik(j'-j)} \langle \hat{a}_{j'}^\dagger \hat{a}_j \rangle. ``` @@ -310,7 +310,7 @@ insulating phase would not. In the thermodynamic limit, one could show that the conditions may be considered as periodic and instead uniformly distribute the phase across the chain as $\hat{a}_i \to \hat{a}_i e^{i\Phi/L}$. Concretely, in the limit of $\Phi/L \to 0$, we have: - + $$\frac{E[\Phi] - E[0]}{L} \approx \frac{1}{2} \Upsilon(L) \bigg (\frac{\Phi}{L}\bigg)^2 + \cdots$$ In order to find the ground state under these twisted boundary conditions, we must construct diff --git a/src/algorithms/changebonds/changebonds.jl b/src/algorithms/changebonds/changebonds.jl index 3a5dbeb5e..9dce51c45 100644 --- a/src/algorithms/changebonds/changebonds.jl +++ b/src/algorithms/changebonds/changebonds.jl @@ -4,7 +4,7 @@ Change the bond dimension of `ψ` using the algorithm `alg`, and return the new `ψ` and the new `envs`. For AbstractInfiniteMPS, changebonds returns new environments without modifying the one provided. -changedbonds! can modifiy both the provided state and environments, depending on the algorithm. +changedbonds! can modify both the provided state and environments, depending on the algorithm. For FiniteMPS, changebonds also modifies the environments. See also: [`SvdCut`](@ref), [`RandExpand`](@ref), [`VUMPSSvdCut`](@ref), [`OptimalExpand`](@ref) diff --git a/src/operators/lazysum.jl b/src/operators/lazysum.jl index 7bb2b5ce8..49af40ba4 100644 --- a/src/operators/lazysum.jl +++ b/src/operators/lazysum.jl @@ -1,7 +1,7 @@ """ LazySum{O} <: AbstractVector{O} -Type that represents a lazy sum i.e explicit summation is only done when needed. +Type that represents a lazy sum i.e explicit summation is only done when needed. This type is basically an `AbstractVector` with some extra functionality to calculate things efficiently. ## Fields @@ -37,7 +37,7 @@ LazySum(ops::AbstractVector, fs::AbstractVector) = LazySum(map(MultipliedOperato # wrapper around _eval_at safe_eval(::TimeDependent, x::LazySum, t::Number) = map(O -> _eval_at(O, t), x) function safe_eval(::TimeDependent, x::LazySum) - throw(ArgumentError("attempting to evaluate time-dependent LazySum without specifiying a time")) + throw(ArgumentError("attempting to evaluate time-dependent LazySum without specifying a time")) end safe_eval(::NotTimeDependent, x::LazySum) = sum(_eval_at, x) function safe_eval(::NotTimeDependent, x::LazySum, t::Number) diff --git a/src/operators/mpohamiltonian.jl b/src/operators/mpohamiltonian.jl index f89d46a9f..cc7e42b15 100644 --- a/src/operators/mpohamiltonian.jl +++ b/src/operators/mpohamiltonian.jl @@ -25,7 +25,7 @@ lattice = fill(ℂ^2, 10) H = MPOHamiltonian(lattice, (i, i+1) => O for i in 1:length(lattice)-1) ``` -See also [`instantiate_operator`](@ref), which is responsable for instantiating the local +See also [`instantiate_operator`](@ref), which is responsible for instantiating the local operators in a form that is compatible with this constructor. """ struct MPOHamiltonian{TO <: JordanMPOTensor, V <: AbstractVector{TO}} <: AbstractMPO{TO} diff --git a/src/states/windowmps.jl b/src/states/windowmps.jl index fb2396da6..e32ac35d2 100644 --- a/src/states/windowmps.jl +++ b/src/states/windowmps.jl @@ -1,7 +1,7 @@ """ WindowMPS{A<:GenericMPSTensor,B<:MPSBondTensor} <: AbstractFiniteMPS -Type that represents a finite Matrix Product State embedded in an infinte Matrix Product State. +Type that represents a finite Matrix Product State embedded in an infinite Matrix Product State. ## Fields @@ -20,7 +20,7 @@ Type that represents a finite Matrix Product State embedded in an infinte Matrix [right_gs::InfiniteMPS]) WindowMPS([f, eltype], physicalspaces::Vector{<:Union{S,CompositeSpace{S}}}, maxvirtualspace::S, left_gs::InfiniteMPS, [right_gs::InfiniteMPS]) - + Construct a WindowMPS via a specification of left and right infinite environment, and either a window state or a vector of tensors to construct the window. Alternatively, it is possible to supply the same arguments as for the constructor of [`FiniteMPS`](@ref), followed by a diff --git a/src/utility/defaults.jl b/src/utility/defaults.jl index 05aa58c69..ddfd02afe 100644 --- a/src/utility/defaults.jl +++ b/src/utility/defaults.jl @@ -91,7 +91,7 @@ const scheduler = Ref{Scheduler}() Set the `OhMyThreads` multi-threading scheduler parameters. -The function either accepts a `scheduler` as an `OhMyThreads.Scheduler` or as a symbol where the corresponding parameters are specificed as keyword arguments. +The function either accepts a `scheduler` as an `OhMyThreads.Scheduler` or as a symbol where the corresponding parameters are specified as keyword arguments. For a detailed description of all schedulers and their keyword arguments consult the [`OhMyThreads` documentation](https://juliafolds2.github.io/OhMyThreads.jl/stable/refs/api/#Schedulers). """ function set_scheduler!(sc = OhMyThreads.Implementation.NotGiven(); kwargs...) diff --git a/src/utility/windowarray.jl b/src/utility/windowarray.jl index afcdcedbe..4de8170d7 100644 --- a/src/utility/windowarray.jl +++ b/src/utility/windowarray.jl @@ -5,7 +5,7 @@ A vector embedded in a periodic environment to the left and right, which can be The `middle` part is a regular `Vector{T}` and the `left` and `right` parts are `PeriodicVector{T}`s. This vector inherits most of its properties from the middle part, including its length and axes. -Nevertheless, indexing operations are overloaded to allow for out-of-bounds access, which is resolved by the periodic enviroments. +Nevertheless, indexing operations are overloaded to allow for out-of-bounds access, which is resolved by the periodic environments. See also [`PeriodicVector`](@ref). """