Skip to content

Commit 9209f29

Browse files
authored
Small typos in README
[skip ci]
1 parent ba4e27b commit 9209f29

File tree

1 file changed

+26
-19
lines changed

1 file changed

+26
-19
lines changed

README.md

Lines changed: 26 additions & 19 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,7 @@ A Julia package for large-scale tensor computations, with a hint of category the
3535
[pkgeval-img]: https://JuliaCI.github.io/NanosoldierReports/pkgeval_badges/T/TensorKit.svg
3636
[pkgeval-url]: https://JuliaCI.github.io/NanosoldierReports/pkgeval_badges/T/TensorKit.html
3737

38-
[codecov-img]:
39-
https://codecov.io/gh/Jutho/TensorKit.jl/branch/master/graph/badge.svg
38+
[codecov-img]: https://codecov.io/gh/Jutho/TensorKit.jl/branch/master/graph/badge.svg
4039
[codecov-url]: https://codecov.io/gh/Jutho/TensorKit.jl
4140

4241
[aqua-img]: https://raw.githubusercontent.com/JuliaTesting/Aqua.jl/master/badge.svg
@@ -48,9 +47,11 @@ TensorKit v0.13 brings a number of performance improvements, but also comes with
4847
breaking changes:
4948

5049
1. The scalar type (the `eltype` of the tensor data) is now an explicit parameter of the
51-
the `TensorMap` type, and appears in the first position. As a consequence, `TensorMap{T}(undef, codomain ← domain)` can and should now be used to create a `TensorMap` with uninitialised data with scalar type `T`.
50+
the `TensorMap` type, and appears in the first position. As a consequence,
51+
`TensorMap{T}(undef, codomain ← domain)` can and should now be used to create a
52+
`TensorMap` with uninitialised data with scalar type `T`.
5253

53-
2. The constructors for creating tensors with randomly initialised data, of the form
54+
3. The constructors for creating tensors with randomly initialised data, of the form
5455
`TensorMap(randn, T, codomain ← domain)`, are being replaced with
5556
`randn(T, codomain ← domain)`. Hence, we overload the methods `rand` and `randn` from
5657
Base (actually, Random, and also `Random.randexp`) and mimick the `Array` constructors,
@@ -62,21 +63,21 @@ breaking changes:
6263
removed in the 1.0 release.
6364

6465
3. The `TensorMap` data structure has been changed (simplified), so that all tensor data now
65-
resides in a single array of type `<:DenseVector`. While this should not does not lead to
66-
breaking changes in the interface, it does mean that `TensorMap` objects from
67-
TensorKit.jl v0.12.7 or earlier that were saved to disk using e.g. JLD2.jl, cannot simply
68-
be read back in using the new version of TensorKit.jl. We provide a script below export
69-
data in a format that can be read back in by TensorKit.jl v0.13.
66+
resides in a single array of type `<:DenseVector`. While this does not lead to breaking
67+
changes in the interface, it does mean that `TensorMap` objects from TensorKit.jl
68+
v0.12.7 or earlier that were saved to disk using e.g. JLD2.jl, cannot simply be read back
69+
in using the new version of TensorKit.jl. We provide a script [below](https://github.com/Jutho/TensorKit.jl/edit/master/README.md#transferring-tensormap-data-from-older-versions-to-v013)
70+
to export data in a format that can be read back in by TensorKit.jl v0.13.
7071

7172
Major non-breaking changes include:
7273

7374
* Support for [TensorOperations.jl v5](https://github.com/Jutho/TensorOperations.jl), and
7475
with this the new backend and allocator support within the `@tensor` macro.
75-
* The part of TensorKit.jl that defines `Sector` type hierarchy and its corresponding
76+
* The part of TensorKit.jl that defines the `Sector` type hierarchy and its corresponding
7677
interface, as well as the implementation of all of the standard symmetries, has been
7778
moved to a separate package called [TensorKitSectors.jl](https://github.com/QuantumKitHub/TensorKitSectors.jl),
7879
so that it can also be used by other packages and is a more lightweight dependency.
79-
TensorKitSectors.jl a direct dependency and is automatically installed when installing
80+
TensorKitSectors.jl is a direct dependency and is automatically installed when installing
8081
TensorKit.jl. Furthermore, its public interface is re-exported by TensorKit.jl, so that
8182
this should not have any observable consequences.
8283
* The `fusiontrees` iterator now iterates over `FusionTree` objects in a different order,
@@ -94,7 +95,7 @@ Major non-breaking changes include:
9495
To export `TensorMap` data from TensorKit.jl v0.12.7 or earlier, you should first export the
9596
data there in a format that is explicit about how tensor data is associated with the
9697
structural part of the tensor, i.e. the splitting and fusion tree pairs. Therefore, on the
97-
older version of TensorKit.jl, use the following code to save teh data
98+
older version of TensorKit.jl, use the following code to save the data
9899

99100
```julia
100101
using JLD2
@@ -135,18 +136,24 @@ end
135136

136137
## Overview
137138

138-
TensorKit.jl is a package that provides a types and methods to represent and manipulate
139+
TensorKit.jl is a package that provides types and methods to represent and manipulate
139140
tensors with symmetries. The emphasis is on the structure and functionality needed to build
140141
tensor network algorithms for the simulation of quantum many-body systems. Such tensors are
141142
typically invariant under a symmetry group which acts via specific representions on each of
142143
the indices of the tensor. TensorKit.jl provides the functionality for constructing such
143144
tensors and performing typical operations such as tensor contractions and decompositions,
144145
thereby preserving the symmetries and exploiting them for optimal performance.
145146

146-
While most common symmetries are already shipped with TensorKit.jl, there exist several extensions: [SUNRepresentations.jl](https://github.com/maartenvd/SUNRepresentations.jl) provides support for SU(N), while [CategoryData.jl](https://github.com/lkdvos/CategoryData.jl) incorporates a large collection of *small* fusion categories.
147-
Additionally, for libraries that implement tensor network algorithms on top of TensorKit.jl, check out [MPSKit.jl](https://github.com/maartenvd/MPSKit.jl), [MERAKit.jl](https://github.com/mhauru/MERAKit.jl) and [PEPSKit.jl](https://github.com/quantumghent/PEPSKit.jl).
147+
While most common symmetries are already shipped with TensorKit.jl, there exist several
148+
extensions: [SUNRepresentations.jl](https://github.com/QuantumKitHub/SUNRepresentations.jl)
149+
provides support for SU(N), while [CategoryData.jl](https://github.com/lkdvos/CategoryData.jl)
150+
incorporates a large collection of *small* fusion categories.
151+
Additionally, for libraries that implement tensor network algorithms on top of
152+
TensorKit.jl, check out [MPSKit.jl](https://github.com/QuantumKitHub/MPSKit.jl),
153+
[MERAKit.jl](https://github.com/mhauru/MERAKit.jl) and [PEPSKit.jl](https://github.com/QuantumKitHub/PEPSKit.jl).
148154

149-
Check out the [tutorial](https://jutho.github.io/TensorKit.jl/stable/man/tutorial/) and the full [documentation](https://jutho.github.io/TensorKit.jl/stable).
155+
Check out the [tutorial](https://jutho.github.io/TensorKit.jl/stable/man/tutorial/) and the
156+
full [documentation](https://jutho.github.io/TensorKit.jl/stable).
150157

151158
## Installation
152159
`TensorKit.jl` can be installed with the Julia package manager.
@@ -163,12 +170,12 @@ julia> import Pkg; Pkg.add("TensorKit.jl")
163170
## Documentation
164171

165172
- [**STABLE**][docs-stable-url] - **documentation of the most recently tagged version.**
166-
- [**DEVEL**][docs-dev-url] - *documentation of the in-development version.*
173+
- [**DEV**][docs-dev-url] - *documentation of the in-development version.*
167174

168175
## Project Status
169176

170-
The package is tested against Julia versions `1.8`, `1.10` and the latest `1.x` release, as
171-
well as against teh nightly builds of the Julia `master` branch on Linux, macOS, and Windows
177+
The package is tested against Julia versions `1.10` and the latest `1.x` release, as
178+
well as against the nightly builds of the Julia `master` branch on Linux, macOS, and Windows
172179
platforms with a 64-bit architecture.
173180

174181
## Questions and Contributions

0 commit comments

Comments
 (0)