diff --git a/docs/src/index.md b/docs/src/index.md index 58b210c..a4508e9 100644 --- a/docs/src/index.md +++ b/docs/src/index.md @@ -3,10 +3,10 @@ Documentation for DTWA.jl ```@docs -repeated_euler -euler_3D -spin_array_3D -intial_Si -J_XYZ -Jx_Ising +DTWA.repeated_euler +DTWA.euler_3D +DTWA.spin_array_3D +DTWA.intial_Si +DTWA.J_XYZ +DTWA.Jx_Ising ``` \ No newline at end of file diff --git a/src/3d.jl b/src/3d.jl index 00f7d74..428d7c1 100644 --- a/src/3d.jl +++ b/src/3d.jl @@ -230,9 +230,8 @@ end Repeatedly computes the time evolution of the spin system of dimensions dim for a certain time interval. -Returns two arrays: the first is the time evolution of the collective spin, defined as ```math -\left[\sum_i^n s_i^x/2, \sum_i^n s_i^y/2, \sum_i^n s_i^z/2\right] -``` +Returns two arrays: the first is the time evolution of the collective spin, defined as +``\left[ \sum_i^n s_i^x/2, \sum_i^n s_i^y/2, \sum_i^n s_i^z/2\right]`` for each trajectory, in the form of a vecotr of length number_trajectories where each value is a vector of length N decribing the time evolution of the collective spin. The second array returned is the time evolution of the collective spin averaged across all trajectories, in the form of a vector of length N where each element is the averaged [sx, sy, sz] spin vector.