Commit bde35cf2 authored by Simon Spannagel's avatar Simon Spannagel
Browse files

Merge branch 'p-doc-installation' into 'master' 

remove binary tarball release and update documentation

Closes #258

See merge request allpix-squared/allpix-squared!939
parents 7e5269ef 8febd27b

.gitlab-ci.yml

+0 −4
Original line number Diff line number Diff line
@@ -565,10 +565,6 @@ deploy:eos: 
        - schedules@allpix-squared/allpix-squared

    dependencies:

        - docs:usermanual-pdf

        - pkg:cc7-gcc

        - pkg:cc7-llvm

        - pkg:cc8-gcc

        - pkg:macos-clang

    # Docker image with tools to deploy to EOS

    image: gitlab-registry.cern.ch/ci-tools/ci-web-deployer:latest

    script:

doc/README.md

+1 −1
Original line number Diff line number Diff line
@@ -107,7 +107,7 @@ also means that explicit backticks (like `` $` `` or `` ```math ``) can't be use 
You can easily test the website of the documentation with your changes yourself by running:

```shell

git clone --recurse-submodules https://gitlab.cern.ch/allpix-squared/allpix-squared-website.git

APSQ_REPO=your_user_name/allpix-squared APSQ_REF=branch_name ./get_artifacts.sh

./get_artifacts.sh ref your_branch_name your_cern_user_name/allpix-squared

hugo server

```

doc/latex/references.bib

+12 −1
Original line number Diff line number Diff line
@@ -51,6 +51,11 @@ 
    month = aug,

    day = {22}

}

@online{ap2-website-repo,

    title = {The Allpix Squared Website Repository},

    author = {},

    url = {https://gitlab.cern.ch/allpix-squared/allpix-squared-website/},

}

@online{ap2-external-modules,

    title = {CMake for External Allpix Squared Modules Repository},

    author = {},
@@ -374,7 +379,13 @@ month={8}, 
    author = {John MacFarlane},

    title = {Pandoc},

    subtitle = {A universal document converter},

    url = {http://pandoc.org/}

    url = {https://pandoc.org/}

}

@online{hugo,

    author = {Bjørn Erik Pedersen},

    title = {hugo},

    subtitle = {A Fast and Flexible Static Site Generator},

    url = {https://gohugo.io/},

}

@online{pdg,

    author = {L. Garren and F. Krauss and C.-J. Lin and S. Navas and P. Richardson and T. Sj\"ostrand},

doc/usermanual/02_installation/08_cvmfs.md

0 → 100644
+28 −0
Original line number Diff line number Diff line 
---

# SPDX-FileCopyrightText: 2023 CERN and the Allpix Squared authors

# SPDX-License-Identifier: CC-BY-4.0

title: "Releases on CVMFS"

weight: 8

---



For each release a binary tarball is created, which is published to CERN's VM file system (CVMFS) \[[@cvmfs]\]. They can be

used to run Allpix Squared without building it beforehand. Compared to the Docker images mentioned in

[Section 2.7](./07_docker_images.md), which can run on any operating system, binary releases are tied to a specific operating

system.



Binaries for Allpix Squared are currently provided for CentOS 7 (both in a GCC and LLVM variant), CentOS 8 (GCC) and MacOS.

Details on the deployment process are given in [Setcion 11.4](../11_devtools/04_deployment.md).



To use Allpix Squared from CVMFS, run:



```shell

source /cvmfs/clicdp.cern.ch/software/allpix-squared/<version>/<system-specifier>/setup.sh

```



Where `<version>` should be replaced with the desired Allpix Squared version (e.g. `2.4.0`) and `<system-specifier>` with the

specifier for the system CVMFS is running on (e.g. `x86_64-centos7-gcc11-opt`).



To verify if Allpix Squared is working, you can run `allpix --version`.





[@cvmfs]: https://pos.sissa.it/070/052/

doc/usermanual/02_installation/_index.md

+3 −0
Original line number Diff line number Diff line
@@ -10,3 +10,6 @@ This chapter aims to provide details and instructions on how to build and instal 
build configurations is given. After installing and loading the required dependencies, there are various options to customize

the installation of Allpix Squared. This chapter contains details on the standard installation process and information about

custom build configurations.



Alternatively, Allpix Squared can installed without building via a Docker image (see [Section 2.7](./07_docker_images.md)) or

via CVMFS (see [Section 2.8](./08_cvmfs.md)).