Docker-in-Docker (DinD) capabilities of public runners deactivated. More info

Commit cf4d736b authored by Pierre Aubert's avatar Pierre Aubert
Browse files

Add quick start doc

parent 3c16b543
Pipeline #93704 failed with stages
in 8 minutes and 24 seconds
......@@ -31,6 +31,7 @@ function(phoenix_base_project programName programVersion programDescritpion prog
add_definitions(--std=c++11 -Wall -Werror -g -O2 -D__PROGRAM_VERSION__="${PROGRAM_VERSION}")
if(DOC_MODE)
pull_extra_module("PhoenixTex2Html" "https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/PhoenixTex2Html.git")
add_subdirectory(doc)
endif()
createLinuxPackages()
......
......@@ -3,6 +3,6 @@ cmake_minimum_required(VERSION 2.8)
phoenix_create_doc(PhoenixHDF5 Doxyfile.cmake)
add_subdirectory(platex)
project(Phoenix)
cmake_minimum_required(VERSION 2.8)
file(GLOB_RECURSE allDocTexFiles "${CMAKE_CURRENT_SOURCE_DIR}/*.tex")
add_custom_command(
OUTPUT ${CMAKE_CURRENT_BINARY_DIR}/index.html
COMMENT "latex documentation generation"
COMMAND ${PHOENIX_TEX_2_HTML_EXECUTABLE} -i ${CMAKE_CURRENT_SOURCE_DIR}/phoenix_hdf5_doc.tex -p ${CMAKE_INSTALL_PREFIX}
DEPENDS ${allDocTexFiles}
WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
)
add_custom_target(doc_latex DEPENDS ${CMAKE_CURRENT_BINARY_DIR}/index.html)
add_dependencies(doc doc_latex)
install(DIRECTORY ${CMAKE_CURRENT_BINARY_DIR} DESTINATION share/PhoenixHDF5/doc/)
\title{PhoenixHDF5 user documentation}
\author{Pierre Aubert}
This is the user documentation. The developer documentation is \href{html/index.html}{here}.
The page of the project is \href{https://gitlab.in2p3.fr/CTA-LAPP/PHOENIX_LIBS/PhoenixHDF5}{here}.
\part{Quick Start}
The program \prog{phoenix_hdf5} is a code generator which automates class development that use \href{https://www.hdfgroup.org/solutions/hdf5/}{HDF5} data format.
This adds a small overlay to gather and mutualise several tables use in the same class (composed of tables and tensors of any types supported by \textbf{HDF5}).
To run \prog{phoenix_hdf5} :
\begin{terminal}
phoenix_hdf5 -i baseConfig.ph5 -o outputDir
\end{terminal}
Where \textbf{outputDir} is the output directory where to create generated code (current directory by default) and the \textbf{baseConfig.ph5} is the class description.
\begin{paragraph}
A simple example :
\end{paragraph}
\begin{ph5}
///Table of values
TableVertex{
///Event id
size_t eventId;
///Timestamp
double timestamp;
///Image
Tensor(float, nbPixel) image;
///Float value
Tensor(float, nbValue, 2) matValue;
}
\end{ph5}
Here, the name of the generated class is \textbf{TableVertex}.
All the defined attributes are stored and read in the same order they are defined.
\begin{paragraph}
A \textbf{Tensor} is defined by its type, first, and then all its dimentions (with variables or fixed values) and you can use as many as dimentions you need.
\end{paragraph}
Markdown is supported
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