updated documentation

src/juobs_obs.jl

@@ -597,7 +597,7 @@ function dec_const(a0pL::Vector{Corr},a0pR::Vector{Corr},ppL::Vector{Corr}, ppR:
   # Example:
   # V = [(a1,a2,a3),(b1,b2,b3)]
   # V = collect.(V) #[[a1,a2,a3],[b1,b2,b3]]
-  # V stack(V) #[a1 b1; a2 b2; a3 b3]
+  # V = stack(V) #[a1 b1; a2 b2; a3 b3]
   # return Tuple([r...] for e in eachrow(r)) #([a1,b1],[a1,b2],[a3,b3])
 
   a = stack(collect.(a));

src/juobs_reader.jl

@@ -86,7 +86,7 @@ end
     read_mesons(path::Vector{String}, g1::Union{String, Nothing}=nothing, g2::Union{String, Nothing}=nothing; id::Union{String, Nothing}=nothing, legacy::Bool=false)
 
 This function read a mesons dat file at a given path and returns a vector of `CData` structures for different masses and Dirac structures.
-Dirac structures `g1` and/or `g2` can be passed as string arguments in order to filter correaltors.
+Dirac structures `g1` (source) and/or `g2` (sink) can be passed as string arguments in order to filter correaltors.
 ADerrors id can be specified as argument. If is not specified, the `id` is fixed according to the ensemble name (example: "H400"-> id = "H400")
 
 *For the old version (without smearing, distance preconditioning and theta) set legacy=true.
@@ -290,8 +290,8 @@ function read_mesons_correction(path::Vector{String}, g1::Union{String, Nothing}
 end
 
 @doc raw"""
-  read_mesons_chunks(paths::Vector{String}, g1::Union{String, Nothing}=nothing, g2::Union{String, Nothing}=nothing; id::Union{String, Nothing}=nothing, legacy::Bool=false,
-  nnoise_trunc::Union{Int64, Nothing}=nothing)
+    read_mesons_chunks(paths::Vector{String}, g1::Union{String, Nothing}=nothing, g2::Union{String, Nothing}=nothing; id::Union{String, Nothing}=nothing, legacy::Bool=false,
+    nnoise_trunc::Union{Int64, Nothing}=nothing)
 
 This function reads mesons dat files stored in chunks and returns a single vector of `CData` structures for different masses and Dirac structures.
   the paths to each chunks is given through the variable `paths::Vector{String}`

src/juobs_tools.jl

@@ -223,11 +223,11 @@ function corr_obs(cdata::Array{CData, 1}; real::Bool=true, rw::Union{Array{Array
 end   
 
 @doc raw"""
-    corr_obs_TSM(cdata_sl::CData, cdata_corr::CData; real::Bool=true, rw::Union{Array{Float64, 2}, Nothing}=nothing, L::Int64=1, info::Bool=false, idm_sl::Union{Vector{Int64},Nothing}=nothing, idm_corr::Union{Vector{Int64},Nothing}=nothing, nms::Int64=Int64(maximum(cdata_sl.vcfg)))
+    corr_obs_TSM(cdata_sl::CData, cdata_corr::CData; real::Bool=true, rw::Union{Array{Float64, 2}, Nothing}=nothing, L::Int64=1, info::Bool=false, idm_sl::Union{Vector{Int64},Nothing}=nothing, idm_corr::Union{Vector{Int64},Nothing}=nothing, nms::Union{Int64,Nothing}=nothing, flag_strange::Bool=false)
+    corr_obs_TSM(cdata1::Array{CData, 1}, cdata2::Array{CData, 1}; real::Bool=true, rw::Union{Array{Array{Float64, 2}, 1}, Nothing}=nothing, L::Int64=1, info::Bool=false, replica_sl::Union{Vector{Int64},Nothing}=nothing, idm_sl::Union{Vector{Int64},Nothing}=nothing, idm_corr::Union{Vector{Int64},Nothing}=nothing, nms::Union{Int64, Nothing}=nothing, flag_strange::Bool=false)
+   
 
-    corr_obs(cdata::Array{CData, 1}; real::Bool=true, rw::Union{Array{Array{Float64, 2}, 1}, Nothing}=nothing, L::Int64=1, info::Bool=false)
-
-Creates a `Corr` struct  for Truncated Solver Method (TSM) with the given `CData` structs `cdata_sl` and `cdata_ex` for a single replica.
+Creates a `Corr` struct  for Truncated Solver Method (TSM) with the given `CData` structs `cdata_sl` and `cdata_corr` for a single replica.
 Two arrays of `CData` can be passed as argument for multiple replicas.
 
 The flag `real` select the real or imaginary part of the correlator.
@@ -243,7 +243,7 @@ The flags `idm_sl`, `idm_corr` and `nms` can be used if the observable is not me
 `nms::Int64` Total number of measurements in the ensembles. By default, nms=maximum(cdata_sl.vcfg) it is assumed that the sloppy observable is full statistics, while the exact observable is not.
 Typically, only `idm_corr` has to be passed, if the exact observable is not full statistics. 
 By playing with these three flags you ensure that the Gamma method is still working even if the configurations between sloppy and correction do not match.
-
+`replica_sl::Vector{Int64}` allows to set the length of each replica independently of `maximum.(vcfg_sl)`. Be aware that `replica_sl` must be equal or larger than `maximum(vcfg_sl)`
 
 ```@example
 #Single replica

src/juobs_types.jl

@@ -197,6 +197,18 @@ end
 
     EnsInfo(ens_id::String, info::Vector{Any})
 
+Stores information about the ensamble `ens_id`
+
+`info::Vector{Any}` is a vector with 6 components that are:
+  -`L::Int64` = number of site in the spatial direction
+  -`T::Int64` = number of site in the temporal direction
+  -`beta::Float64`
+  -`ca::Float64` = c_A improvement parameters of the axial current
+  -`dtr::Int64` = ??
+  -`vrw::Union{String,Vector{string}}` = version of the reweighting factor. 
+  -`cnfg::Vector{Int64}`= number of configuration per replica
+The fields in `EnsInfo` are the same as before, plus the `id::String` of the ensemble
+
 Examples:
 ```@example    
 id = "H101"