Skip to content

Commit b40c82c

Browse files
authored
[Docs] "Manipulating States and Operators" and "Tensor Products and Partial Traces" (#223)
2 parents 3f2eaab + c619379 commit b40c82c

File tree

12 files changed

+598
-27
lines changed

12 files changed

+598
-27
lines changed

README.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -144,8 +144,6 @@ We can extract the expectation value of the number operator $\hat{a}^\dagger \ha
144144

145145
We can easily pass the computation to the GPU, by simply passing all the `Qobj`s to the GPU:
146146

147-
> **_NOTE:_** The described feature requires `Julia 1.9+`.
148-
149147
```julia
150148
using QuantumToolbox
151149
using CUDA

docs/make.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -21,14 +21,14 @@ const PAGES = [
2121
"Getting Started" => [
2222
"Introduction" => "index.md",
2323
"Key differences from QuTiP" => "qutip_differences.md",
24+
"The Importance of Type-Stability" => "type_stability.md",
2425
# "Cite QuantumToolbox.jl" => "cite.md",
2526
],
2627
"Users Guide" => [
2728
"Basic Operations on Quantum Objects" => [
2829
"users_guide/QuantumObject/QuantumObject.md",
2930
"users_guide/QuantumObject/QuantumObject_functions.md",
3031
],
31-
"The Importance of Type-Stability" => "users_guide/type_stability.md",
3232
"Manipulating States and Operators" => "users_guide/states_and_operators.md",
3333
"Tensor Products and Partial Traces" => "users_guide/tensor.md",
3434
"Time Evolution and Dynamics" => [

docs/src/index.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,9 +97,6 @@ We can extract the expectation value of the number operator ``\hat{a}^\dagger \h
9797

9898
We can easily pass the computation to the GPU, by simply passing all the `Qobj`s to the GPU:
9999

100-
!!! compat "Compat"
101-
The described feature requires `Julia 1.9+`. See [CUDA extension](@ref doc:CUDA) for more details.
102-
103100
```julia
104101
using QuantumToolbox
105102
using CUDA
File renamed without changes.

docs/src/users_guide/QuantumObject/QuantumObject.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,6 +14,9 @@ The key difference between classical and quantum mechanics is the use of operato
1414
- `CUDA.CUSPARSE.CuSparseMatrixCSR` (sparse GPU matrix)
1515
- and even more ...
1616

17+
!!! note "Support for GPU arrays"
18+
See [CUDA extension](@ref doc:CUDA) for more details.
19+
1720
We can create a [`QuantumObject`](@ref) with a user defined data set by passing an array of data into the [`QuantumObject`](@ref):
1821

1922
```@setup Qobj
@@ -53,7 +56,7 @@ Qobj(rand(4, 4), type = SuperOperator)
5356
```
5457

5558
!!! note "Difference between `dims` and `size`"
56-
Notice that `type`, `dims`, and `size` will change according to the input `data`. Although `dims` and `size` appear to be the same, `dims` keep tracking the dimension of individual Hilbert spaces of a multipartite system, while `size` does not. We refer the reader to the section [tensor products and partial traces](@ref doc:Tensor-products) for more information.
59+
Notice that `type`, `dims`, and `size` will change according to the input `data`. Although `dims` and `size` appear to be the same, `dims` keep tracking the dimension of individual Hilbert spaces of a multipartite system, while `size` does not. We refer the reader to the section [Tensor Products and Partial Traces](@ref doc:Tensor-products-and-Partial-Traces) for more information.
5760

5861
## States and operators
5962

docs/src/users_guide/extensions/cuda.md

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -4,9 +4,6 @@
44

55
This is an extension to support `QuantumObject.data` conversion from standard dense and sparse CPU arrays to GPU ([`CUDA.jl`](https://github.com/JuliaGPU/CUDA.jl)) arrays.
66

7-
!!! note "Requirements"
8-
The [`CUDA.jl`](https://github.com/JuliaGPU/CUDA.jl) extension for `QuantumToolbox.jl` requires `Julia 1.9+`.
9-
107
This extension will be automatically loaded if user imports both `QuantumToolbox` and [`CUDA.jl`](https://github.com/JuliaGPU/CUDA.jl):
118

129
```julia

0 commit comments

Comments
 (0)