Commit e4fc55f4 authored by Jonas Schwab's avatar Jonas Schwab
Browse files

Documentation: Add figure describing structure of HDF5 file data.h5

parent 6c2a9f11
Pipeline #12693 failed with stages
in 162 minutes and 45 seconds
No preview for this file type
......@@ -46,6 +46,7 @@
\usepackage{showexpl}
\usepackage{etoolbox}
\usepackage{calc}
\usepackage{dirtree}
\makeatletter
\renewcommand\paragraph{\@startsection{paragraph}{4}{\z@}%
......
......@@ -208,6 +208,22 @@ The output of the measured data is organized in bins. One bin corresponds to the
\end{center}
\end{table}
\begin{figure}
\dirtree{%
.1 data.h5.
.2 lattice\DTcomment{Attached attributes describe Bravais lattice and unit cell}.
.2 X\_scal\DTcomment{Attached attribute: analysis\_mode}.
.3 obser\DTcomment{Dataset of shape (NBins, Nobs, 2)}.
.3 sign\DTcomment{Dataset of shape (NBins)}.
.2 Y\_eq Y\_tau\DTcomment{Attached attributes: Channel, dtau}.
.3 lattice\DTcomment{Attached attributes describe Bravais lattice and unit cell}.
.3 obser\DTcomment{Dataset of shape (NBins, Norbs, Norbs, Ntau, Nlatt, 2)}.
.3 back\DTcomment{Dataset of shape (NBins, Norbs, 2)}.
.3 sign\DTcomment{Dataset of shape (NBins)}.
}
\caption{Structure of HDF5 file \texttt{data.h5}.}
\end{figure}
The formatting of a single bin's output depends on the observable type, \path{Obs_vec} or \path{Obs_Latt}:
\begin{itemize}
\item Observables of type \path{Obs_vec}:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment