diff --git a/docs/make.jl b/docs/make.jl index a76af27..5c3bea0 100644 --- a/docs/make.jl +++ b/docs/make.jl @@ -2,11 +2,16 @@ using LindbladVectorizedTensors using ITensors using Documenter -DocMeta.setdocmeta!(LindbladVectorizedTensors, :DocTestSetup, :(using LindbladVectorizedTensors); recursive=true) +DocMeta.setdocmeta!( + LindbladVectorizedTensors, + :DocTestSetup, + :(using LindbladVectorizedTensors); + recursive=true, +) makedocs(; modules=[LindbladVectorizedTensors], - checkdocs = :none, + checkdocs=:none, authors="Davide Ferracin and contributors", sitename="LindbladVectorizedTensors.jl", format=Documenter.HTML(; @@ -16,10 +21,10 @@ makedocs(; ), pages=[ "Home" => "index.md", + "New site types" => "included_site_types.md", + "Examples" => "gksl_example.md", + "Reference" => "physical_operators.md", ], ) -deploydocs(; - repo="github.com/phaerrax/LindbladVectorizedTensors.jl", - devbranch="main", -) +deploydocs(; repo="github.com/phaerrax/LindbladVectorizedTensors.jl", devbranch="main") diff --git a/docs/src/gksl_example.md b/docs/src/gksl_example.md index 6b53660..fcc5873 100644 --- a/docs/src/gksl_example.md +++ b/docs/src/gksl_example.md @@ -1,4 +1,4 @@ -# Application: GKSL equation +# GKSL equation With the states and operators defined by this package, we can define a Lindbladian operator acting on density matrices in a GKSL equation. diff --git a/docs/src/included_site_types.md b/docs/src/included_site_types.md index dc445b0..25a42de 100644 --- a/docs/src/included_site_types.md +++ b/docs/src/included_site_types.md @@ -1,4 +1,4 @@ -# SiteTypes included with PseudomodesTTEDOPA +# SiteTypes included in this package This package extends the SiteType collection provided by ITensor, by defining types for (vectorized) density matrices associated to built-in and operators acting on them. diff --git a/docs/src/index.md b/docs/src/index.md index 0fd5b13..c0e1cae 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,52 +1,3 @@ -# PseudomodesTTEDOPA.jl +# LindbladVectorizedTensors.jl -Documentation for PseudomodesTTEDOPA.jl - -### Spin chain operators -```@docs -exchange_interaction -exchange_interaction_adjoint -exchange_interaction′ -spin_chain -spin_chain_adjoint -spin_chain′ -``` - -### Pseudomode operators -```@docs -dissipator_loss -dissipator_gain -dissipator -mixedlindbladplus -mixedlindbladminus -``` - -### Markovian closure operators -```@docs -Closure -``` -```@docs -closure -``` -```@docs -length(mc::Closure) -freqs(mc::Closure) -innercoups(mc::Closure) -outercoups(mc::Closure) -damps(mc::Closure) -freq(mc::Closure, j::Int) -innercoup(mc::Closure, j::Int) -outercoup(mc::Closure, j::Int) -damp(mc::Closure, j::Int) -``` - -```@docs -closure_op(mc::Closure, sites::Vector{<:Index}, chain_edge_site::Int) -closure_op_adjoint( - mc::Closure, sites::Vector{<:Index}, chain_edge_site::Int, gradefactor::Int -) -closure_op′ -filled_closure_op -filled_closure_op_adjoint -filled_closure_op′ -``` +Documentation for LindbladVectorizedTensors. diff --git a/docs/src/physical_operators.md b/docs/src/physical_operators.md new file mode 100644 index 0000000..c2404ce --- /dev/null +++ b/docs/src/physical_operators.md @@ -0,0 +1,50 @@ +# Physical operators + +## Spin chain operators +```@docs +exchange_interaction +exchange_interaction_adjoint +exchange_interaction′ +spin_chain +spin_chain_adjoint +spin_chain′ +``` + +## Pseudomode operators +```@docs +dissipator_loss +dissipator_gain +dissipator +mixedlindbladplus +mixedlindbladminus +``` + +## Markovian closure operators +```@docs +Closure +``` +```@docs +closure +``` +```@docs +length(mc::Closure) +freqs(mc::Closure) +innercoups(mc::Closure) +outercoups(mc::Closure) +damps(mc::Closure) +freq(mc::Closure, j::Int) +innercoup(mc::Closure, j::Int) +outercoup(mc::Closure, j::Int) +damp(mc::Closure, j::Int) +``` + +```@docs +closure_op(mc::Closure, sites::Vector{<:Index}, chain_edge_site::Int) +closure_op_adjoint( + mc::Closure, sites::Vector{<:Index}, chain_edge_site::Int, gradefactor::Int +) +closure_op′ +filled_closure_op +filled_closure_op_adjoint +filled_closure_op′ +```