Loading doc/latex/allpix-manual.tex +5 −1 Original line number Diff line number Diff line Loading @@ -19,6 +19,7 @@ % References \usepackage[style=ext-numeric-verb,backend=biber,autocite=plain,sorting=none,url=false]{biblatex} \usepackage[unicode]{hyperref} \usepackage{bookmark} \DeclareOuterCiteDelims{cite}{}{} % Math Loading @@ -44,10 +45,13 @@ \providecommand{\tightlist}{% \setlength{\itemsep}{0pt}\setlength{\parskip}{0pt}} % To fix warnings \usepackage{scrhack} % Latin Modern fonts \setmainfont{Latin Modern Roman} \setsansfont{Latin Modern Sans} \setmonofont{Latin Modern Mono} \setmonofont{Latin Modern Mono Light} \setmathfont{Latin Modern Math} % Front matter settings Loading doc/usermanual/02_installation/02_prerequisites.md +3 −3 Original line number Diff line number Diff line Loading @@ -11,14 +11,14 @@ from the CVMFS file system. The core framework is compiled separately from the individual modules and Allpix Squared has therefore only two required external dependencies: - ROOT 6 \[[@root]\]: - ROOT 6 \[[@root]\]: ROOT is used for histogramming as well as coordinate transformations. In addition, some modules implement I/O using ROOT libraries. The latest stable release of ROOT 6 is recommended and older versions, such as ROOT 5.x, are not supported. libraries. The latest stable release of ROOT 6 is recommended and older versions, such as ROOT 5.x, are not supported. Please refer to \[[@rootinstallation]\] for instructions on how to install ROOT. ROOT has several components of which the `GenVector` package is required to run Allpix Squared. This package is included in the default build. ROOT needs to be built using C++17, which is accomplished by supplying the CMake flag `-DCMAKE_CXX_STANDARD=17`. - Boost.Random 1.64.0 or later \[[@boostrandom]\]: - Boost.Random 1.64.0 or later \[[@boostrandom]\]: Random number generator and distribution library of the Boost project, used in order to get cross-platform portable, STL-compatible random number distributions. While STL random number generators are portable and guarantee to deliver the same random number sequence given the same seed, random distributions are not, and their implementation is Loading doc/usermanual/10_devtools/03_ci.md +1 −1 Original line number Diff line number Diff line Loading @@ -16,7 +16,7 @@ found in the `.gitlab/ci` directory. all jobs passed.* The **compilation** stage builds the framework from the source on different platforms. Currently, builds are performed on CentOS 7, CentOS 8, and macOS. On Linux type platforms, the framework is compiled with recent versions of GCC and Clang, while CentOS 7, CentOS 8, and macOS. On Linux type platforms, the framework is compiled with recent versions of GCC and Clang, while the latest AppleClang is used on macOS. The build is always performed with the default compiler flags enabled for the project: ``` Loading doc/usermanual/10_devtools/04_deployment.md +1 −1 Original line number Diff line number Diff line Loading @@ -20,7 +20,7 @@ The software is automatically deployed to CERN's VM file system (CVMFS) \[[@cvmf The deployed version currently comprises all modules as well as the detector models shipped with the framework. An additional `setup.sh` is placed in the root folder of the respective release, which allows to set up all runtime dependencies necessary for executing this version. Versions both for CentOS 7 and CentOS 8 are provided. for executing this version. Versions both for CentOS 7 and CentOS 8 are provided. The deployment CI job runs on a dedicated computer with a GitLab SSH runner. Job artifacts from the packaging stage of the CI are downloaded via their ID using the script found in `.gitlab/ci/download_artifacts.py`, and are made available to the Loading doc/usermanual/12_faq/01_installation.md +1 −1 Original line number Diff line number Diff line Loading @@ -8,7 +8,7 @@ weight: 1 #### What is the easiest way to use Allpix Squared on CERN's LXPLUS? Central installations of Allpix Squared on LXPLUS are provided via CVMFS for both supported LXPLUS operating systems, CERN CentOS 7 and CentOS 8. Please refer to [Section 10.4](../10_devtools/04_deployment.md#software-deployment-to-cvmfs) for the CentOS 7 and CentOS 8. Please refer to [Section 10.4](../10_devtools/04_deployment.md#software-deployment-to-cvmfs) for the details of how to access these installations. #### What is the quickest way to get a local installation of Allpix Squared? Loading Loading
doc/latex/allpix-manual.tex +5 −1 Original line number Diff line number Diff line Loading @@ -19,6 +19,7 @@ % References \usepackage[style=ext-numeric-verb,backend=biber,autocite=plain,sorting=none,url=false]{biblatex} \usepackage[unicode]{hyperref} \usepackage{bookmark} \DeclareOuterCiteDelims{cite}{}{} % Math Loading @@ -44,10 +45,13 @@ \providecommand{\tightlist}{% \setlength{\itemsep}{0pt}\setlength{\parskip}{0pt}} % To fix warnings \usepackage{scrhack} % Latin Modern fonts \setmainfont{Latin Modern Roman} \setsansfont{Latin Modern Sans} \setmonofont{Latin Modern Mono} \setmonofont{Latin Modern Mono Light} \setmathfont{Latin Modern Math} % Front matter settings Loading
doc/usermanual/02_installation/02_prerequisites.md +3 −3 Original line number Diff line number Diff line Loading @@ -11,14 +11,14 @@ from the CVMFS file system. The core framework is compiled separately from the individual modules and Allpix Squared has therefore only two required external dependencies: - ROOT 6 \[[@root]\]: - ROOT 6 \[[@root]\]: ROOT is used for histogramming as well as coordinate transformations. In addition, some modules implement I/O using ROOT libraries. The latest stable release of ROOT 6 is recommended and older versions, such as ROOT 5.x, are not supported. libraries. The latest stable release of ROOT 6 is recommended and older versions, such as ROOT 5.x, are not supported. Please refer to \[[@rootinstallation]\] for instructions on how to install ROOT. ROOT has several components of which the `GenVector` package is required to run Allpix Squared. This package is included in the default build. ROOT needs to be built using C++17, which is accomplished by supplying the CMake flag `-DCMAKE_CXX_STANDARD=17`. - Boost.Random 1.64.0 or later \[[@boostrandom]\]: - Boost.Random 1.64.0 or later \[[@boostrandom]\]: Random number generator and distribution library of the Boost project, used in order to get cross-platform portable, STL-compatible random number distributions. While STL random number generators are portable and guarantee to deliver the same random number sequence given the same seed, random distributions are not, and their implementation is Loading
doc/usermanual/10_devtools/03_ci.md +1 −1 Original line number Diff line number Diff line Loading @@ -16,7 +16,7 @@ found in the `.gitlab/ci` directory. all jobs passed.* The **compilation** stage builds the framework from the source on different platforms. Currently, builds are performed on CentOS 7, CentOS 8, and macOS. On Linux type platforms, the framework is compiled with recent versions of GCC and Clang, while CentOS 7, CentOS 8, and macOS. On Linux type platforms, the framework is compiled with recent versions of GCC and Clang, while the latest AppleClang is used on macOS. The build is always performed with the default compiler flags enabled for the project: ``` Loading
doc/usermanual/10_devtools/04_deployment.md +1 −1 Original line number Diff line number Diff line Loading @@ -20,7 +20,7 @@ The software is automatically deployed to CERN's VM file system (CVMFS) \[[@cvmf The deployed version currently comprises all modules as well as the detector models shipped with the framework. An additional `setup.sh` is placed in the root folder of the respective release, which allows to set up all runtime dependencies necessary for executing this version. Versions both for CentOS 7 and CentOS 8 are provided. for executing this version. Versions both for CentOS 7 and CentOS 8 are provided. The deployment CI job runs on a dedicated computer with a GitLab SSH runner. Job artifacts from the packaging stage of the CI are downloaded via their ID using the script found in `.gitlab/ci/download_artifacts.py`, and are made available to the Loading
doc/usermanual/12_faq/01_installation.md +1 −1 Original line number Diff line number Diff line Loading @@ -8,7 +8,7 @@ weight: 1 #### What is the easiest way to use Allpix Squared on CERN's LXPLUS? Central installations of Allpix Squared on LXPLUS are provided via CVMFS for both supported LXPLUS operating systems, CERN CentOS 7 and CentOS 8. Please refer to [Section 10.4](../10_devtools/04_deployment.md#software-deployment-to-cvmfs) for the CentOS 7 and CentOS 8. Please refer to [Section 10.4](../10_devtools/04_deployment.md#software-deployment-to-cvmfs) for the details of how to access these installations. #### What is the quickest way to get a local installation of Allpix Squared? Loading