From f3490596e45f4532df3283e29b7bbb52c2df236e Mon Sep 17 00:00:00 2001 From: Thibaut Lacroix <57836508+tfmlaX@users.noreply.github.com> Date: Sat, 17 Feb 2024 12:19:39 +0100 Subject: [PATCH] Update index.md --- docs/src/index.md | 25 +++++++++++++++++++++++-- 1 file changed, 23 insertions(+), 2 deletions(-) diff --git a/docs/src/index.md b/docs/src/index.md index 350d0fa..5a4a677 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -1,5 +1,26 @@ -# MPSDynamics.jl Documentation +# Introduction + +The `MPSDynamics.jl` package provides an easy to use interface for performing tensor network simulations on matrix product states (MPS) and tree tensor network (TTN) states. +Written in the Julia programming language, `MPSDynamics.jl` is a versatile open-source package providing a choice of several variants of the Time-Dependent Variational Principle (TDVP) method for time evolution. +The package also provides strong support for the measurement of observables, as well as the storing and logging of data, which makes it a useful tool for the study of many-body physics. +The package has been developed with the aim of studying non-Markovian open system dynamics at finite temperature using the state-of-the-art numerically exact Thermalized-Time Evolving Density operator with Orthonormal Polynomials Algorithm (T-TEDOPA) based on environment chain mapping. +However the methods implemented can equally be applied to other areas of physics. + +## Table of Contents + +```@contents +``` + +## Installation + +The package may be installed by typing the following into a Julia REPL + +```julia + ] add https://github.com/shareloqs/MPSDynamics.git +``` + +## Functions ```@autodocs Modules = [MPSDynamics] -``` \ No newline at end of file +```