Merge pull request #290 from kjvbrt/chunksfractions

Revising handling of the chunks and fractions in processList

CMakeLists.txt

@@ -135,6 +135,11 @@ file(GLOB _run_python_files python/*.py)
 install(FILES ${_run_python_files} DESTINATION ${CMAKE_INSTALL_PREFIX}/python)
 
 
+file(GLOB _man_files_1 man/man1/*.1)
+install(FILES ${_man_files_1} DESTINATION ${CMAKE_INSTALL_PREFIX}/share/man/man1)
+file(GLOB _man_files_7 man/man7/*.7)
+install(FILES ${_man_files_7} DESTINATION ${CMAKE_INSTALL_PREFIX}/share/man/man7)
+
 #--- Descend into subdirectories ----------------------------------------------
 
 set(ADDONS_LIBRARIES CACHE STRING "List of external libraries the RDF utilities will be linked against")

man/man1/fccanalysis-run.1

@@ -1,6 +1,6 @@
 .\" Manpage for fccanalysis
 .\" Contact [email protected] to correct errors or typos.
-.TH FCCANALYSIS\-RUN 1 "12 May 2023" "0.6.0" "fccanalysis-run man page"
+.TH FCCANALYSIS\-RUN 1 "24 May 2023" "0.7.0" "fccanalysis-run man page"
 .SH NAME
 fccanalysis\-run \- run FCC analysis
 .SH SYNOPSIS
@@ -117,15 +117,15 @@ Part of the FCCAnalyses framework\&.
 .PP
 1\&. FCCAnalyses webpage
 .RS 4
-\m[blue]https://hep-fcc\&.github\&.io/FCCAnalyses/\[]
+https://hep-fcc\&.github\&.io/FCCAnalyses/
 .RE
 .PP
 2\&. FCCAnalysises GitHub repository
 .RS
-\m[blue]https://github\&.com/HEP-FCC/FCCAnalyses/\[]
+https://github\&.com/HEP\-FCC/FCCAnalyses/
 .RE
 .PP
 3\&. FCCSW Forum
 .RS
-\m[blue]https://fccsw-forum\&.web\&.cern\&.ch/\[]
+https://fccsw\-forum\&.web\&.cern\&.ch/
 .RE

man/man1/fccanalysis.1

@@ -1,6 +1,6 @@
 .\" Manpage for fccanalysis
 .\" Contact [email protected] to correct errors or typos.
-.TH FCCANALYSIS 1 "12 May 2023" "0.6.0" "fccanalysis man page"
+.TH FCCANALYSIS 1 "24 May 2023" "0.7.0" "fccanalysis man page"
 .SH NAME
 fccanalysis \- build and run your FCC analysis
 .SH SYNOPSIS
@@ -70,15 +70,15 @@ Part of the FCCAnalyses framework\&.
 .PP
 1\&. FCCAnalyses webpage
 .RS 4
-\m[blue]https://hep-fcc\&.github\&.io/FCCAnalyses/\[]
+https://hep\-fcc\&.github\&.io/FCCAnalyses/
 .RE
 .PP
 2\&. FCCAnalysises GitHub repository
 .RS
-\m[blue]https://github\&.com/HEP-FCC/FCCAnalyses/\[]
+https://github\&.com/HEP-FCC/FCCAnalyses/
 .RE
 .PP
 3\&. FCCSW Forum
 .RS
-\m[blue]https://fccsw-forum\&.web\&.cern\&.ch/\[]
+https://fccsw\-forum\&.web\&.cern\&.ch/
 .RE

man/man7/fccanalysis-file.7

@@ -1,6 +1,6 @@
 .\" Manpage for fccanalysis-file
 .\" Contact [email protected] to correct errors or typos.
-.TH FCCANALYSIS\-FILE 7 "12 May 2023" "0.6.0" "fccanalysis-file man page"
+.TH FCCANALYSIS\-FILE 7 "24 May 2023" "0.7.0" "fccanalysis-file man page"
 .SH NAME
 fccanalysis\-file \- analysis file specification
 .SH SYNOPSIS
@@ -52,6 +52,33 @@ find the information, one of them uses YAML file which is being searched for in
 the subfolders of $FCCDICTSDIR.
 .RE
 .PP
+\fBprocessList\fR
+.RS 4
+Dictionary of process samples to be run over. Each process can have several
+parameters:
+.br
+\fIfraction\fR
+.RS 4
+The analysis will run over reduced number of input files roughly corresponding
+to the fraction of total events specified\&.
+.br
+Default value: 1 (full process sample)
+.RE
+\fIoutput\fR
+.RS 4
+Specifies the stem for the output file(s)\&. The stem will be used to create
+output directory if there is more than one chunk or as a filename if there is
+only one\&.
+.br
+Default value: output\&.root
+.RE
+\fIchunks\fR
+.RS 4
+The analysis RDataFrame can be split into several chunks\&.
+.br
+Default value: 1
+.RE
+.PP
 This section is under construction. You are invited to help :)
 .SH SEE ALSO
 fccanalysis(1), fccanalysis-run(1)
@@ -74,15 +101,15 @@ Part of the FCCAnalyses framework\&.
 .PP
 1\&. FCCAnalyses webpage
 .RS 4
-\m[blue]https://hep-fcc\&.github\&.io/FCCAnalyses/\[]
+https://hep-fcc\&.github\&.io/FCCAnalyses/
 .RE
 .PP
 2\&. FCCAnalysises GitHub repository
 .RS
-\m[blue]https://github\&.com/HEP-FCC/FCCAnalyses/\[]
+https://github\&.com/HEP\-FCC/FCCAnalyses/
 .RE
 .PP
 3\&. FCCSW Forum
 .RS
-\m[blue]https://fccsw-forum\&.web\&.cern\&.ch/\[]
+https://fccsw\-forum\&.web\&.cern\&.ch/
 .RE