mirror of
https://github.com/vale981/Looping.jl
synced 2025-03-05 09:21:37 -05:00
add floquet utility docs
This commit is contained in:
parent
fa996de265
commit
1deba1ce10
4 changed files with 24 additions and 4 deletions
|
@ -1,5 +1,7 @@
|
||||||
push!(LOAD_PATH,"../src/")
|
push!(LOAD_PATH, "../src/")
|
||||||
using Documenter, Looping
|
using Documenter, Looping
|
||||||
|
|
||||||
DocMeta.setdocmeta!(Looping.Utilities, :DocTestSetup, :(using Looping.Utilities); recursive=true)
|
DocMeta.setdocmeta!(Looping.Utilities, :DocTestSetup, :(using Looping.Utilities); recursive=true)
|
||||||
makedocs(sitename="Looping Documentation", modules=[Looping.Utilities], draft=false, strict=:doctest)
|
DocMeta.setdocmeta!(Looping.FloquetUtils, :DocTestSetup, :(using Looping.FloquetUtils); recursive=true)
|
||||||
|
|
||||||
|
makedocs(sitename="Looping Documentation", modules=map(eval, modules), draft=false, strict=:doctest)
|
||||||
|
|
|
@ -6,6 +6,6 @@ engineering project.
|
||||||
|
|
||||||
|
|
||||||
```@contents
|
```@contents
|
||||||
Pages = ["modules/Utilities.md"]
|
Pages = ["modules/Utilities.md" "modules/FloquetUtilities.md"]
|
||||||
Depth = 3
|
Depth = 3
|
||||||
```
|
```
|
||||||
|
|
19
docs/src/modules/FloquetUtils.md
Normal file
19
docs/src/modules/FloquetUtils.md
Normal file
|
@ -0,0 +1,19 @@
|
||||||
|
# Floquet Utilities
|
||||||
|
|
||||||
|
```@docs
|
||||||
|
Looping.FloquetUtils
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
```@meta
|
||||||
|
CurrentModule = Looping.FloquetUtils
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
```@docs
|
||||||
|
time_evolution_op
|
||||||
|
floquet_hamiltonian
|
||||||
|
trivial_floquet_hamiltonian
|
||||||
|
KickOperator
|
||||||
|
```
|
|
@ -3,7 +3,6 @@ This is a loose collection to naively calculate the time evolution
|
||||||
operator and Floquet Hamiltonian for a given time dependent
|
operator and Floquet Hamiltonian for a given time dependent
|
||||||
Hamiltonian `H(t)`.
|
Hamiltonian `H(t)`.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
module FloquetUtils
|
module FloquetUtils
|
||||||
|
|
||||||
import LinearAlgebra: I, eigvecs, eigen, Diagonal
|
import LinearAlgebra: I, eigvecs, eigen, Diagonal
|
||||||
|
|
Loading…
Add table
Reference in a new issue