Skip to content

Commit 6ef31eb

Browse files
hscheidhscheid
committed
Add prerequisits/alibuild to installation guide
1 parent 14fe36f commit 6ef31eb

File tree

1 file changed

+191
-1
lines changed

1 file changed

+191
-1
lines changed

‎docs/gettingstarted/installing.md‎

Lines changed: 191 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,197 @@ can also automatically download precompiled binaries if possible.
1010

1111
## Installing aliBuild
1212

13-
Follow the instructions <a href="https://alice-doc.github.io/alice-analysis-tutorial/building/custom.html" target="_blank">here</a>. Do not follow "build the packages" on that page.
13+
Building software has become an increasingly complicated operation, as our software has many dependencies and we expect it to work both on your laptop and on the Grid. In addition, we support many Linux distributions and recent macOS versions.
14+
15+
ALICE uses aliBuild to build software. aliBuild:
16+
17+
* knows how to build software via per-package recipes,
18+
* manages the dependencies consistently,
19+
* rebuilds only what's necessary,
20+
* allows several versions of the same software to be installed at the same time.
21+
22+
### Operating systems we support
23+
24+
#### Prerequisites
25+
26+
According to your operating system, please follow the prerequisites below. You will find a list of packages to install and configurations to perform.
27+
28+
##### Primary supported platform:
29+
30+
* [CentOS 7](#prereq-for-centos7)
31+
* [CentOS/AlmaLinux 8](#prereq-for-centos8)
32+
* [AlmaLinux 9](#prereq-for-alma9)
33+
34+
##### Platforms supported on a best-effort basis:
35+
36+
* macOS Sonoma and Sequoia (14.0, 15.0)
37+
* Ubuntu (20.04 LTS, 22.04 LTS, 24.04 LTS)
38+
* Fedora
39+
40+
If your operating system is *not* in any list, it does not mean our software won't work on it; it will be just more difficult for you to get support for it.
41+
42+
Only in case you cannot install aliBuild in the way described above, you can install aliBuild manually. This procedure should only be used as a fall-back, in case you cannot follow the instructions for your operating system linked above.
43+
44+
45+
<h6 id=<prereq-for-centos7> aliBuild prerequisites for CentOS7 </h6>
46+
47+
With root permission, i.e. `sudo` or as `root`install the prerequisits using:
48+
```bash
49+
cat << EOF > /etc/yum.repos.d/alice-system-deps.repo
50+
[alice-system-deps]
51+
name=alice-system-deps
52+
baseurl=https://s3.cern.ch/swift/v1/alibuild-repo/RPMS/o2-full-deps_x86-64/
53+
enabled=1
54+
gpgcheck=0
55+
EOF
56+
yum update -y
57+
yum install -y alice-o2-full-deps
58+
yum update -y
59+
yum install -y alibuild
60+
```
61+
62+
<h6 id=<prereq-for-centos8> aliBuild prerequisites for CentOS8 </h6>
63+
64+
With root permission, i.e. `sudo` or as `root` install the prerequisits using:
65+
```bash
66+
yum install -y epel-release
67+
yum install -y dnf-plugins-core
68+
yum config-manager --set-enabled powertools
69+
yum update -y
70+
71+
dnf group install -y "Development Tools"
72+
73+
cat << EOF > /etc/yum.repos.d/alice-system-deps.repo
74+
[alice-system-deps]
75+
name=alice-system-deps
76+
baseurl=https://s3.cern.ch/swift/v1/alibuild-repo/RPMS/o2-full-deps_el8.x86-64/
77+
enabled=1
78+
gpgcheck=0
79+
EOF
80+
yum update -y
81+
yum install -y alice-o2-full-deps alibuild
82+
```
83+
84+
<h6 id="prereq-for-alma9"> aliBuild prerequisites for AlmaLinux9 </h6>
85+
86+
With root permission, i.e. `sudo` or as `root`install the prerequisits using:
87+
```bash
88+
dnf install -y epel-release dnf-plugins-core
89+
dnf update -y
90+
dnf config-manager --set-enabled crb
91+
dnf group install -y 'Development Tools'
92+
cat << EOF > /etc/yum.repos.d/alice-system-deps.repo
93+
[alice-system-deps]
94+
name=alice-system-deps
95+
baseurl=https://s3.cern.ch/swift/v1/alibuild-repo/RPMS/o2-full-deps_el9.x86-64/
96+
enabled=1
97+
gpgcheck=0
98+
EOF
99+
dnf update -y
100+
dnf install -y alice-o2-full-deps alibuild
101+
```
102+
103+
<h6 id="prereq-for-macos">aliBuild prerequisites for macOS</h6>
104+
105+
**Get Xcode**<br>
106+
Xcode bundles the necessary tools to build software in the apple ecosystem including compilers, build systems and version control.
107+
108+
* Download it from the [App Store](https://itunes.apple.com/gh/app/xcode/id497799835?mt=12)
109+
* Open once installed. It will ask to install additional components - approve the action.
110+
* Open a terminal (Applicaions>Utilities>Terminal) and install the command line tools using: <br>
111+
* `sudo xcode-select --install`
112+
* Approve the license conditions by <br>
113+
`sudo xcodebuild -license`
114+
115+
**Get Homebrew**<br>
116+
[Homebrew](https://brew.sh/) is a command-line package manager for macOS used to install software packages similar to `yum` on CentOS or `apt` on Ubuntu.
117+
118+
* Install Homebrew using the [instructions on their webpage](https://brew.sh/).
119+
* Once installed detect any problems regarding Homebrew and your system using: `brew doctor`
120+
121+
122+
**Uninstall ROOT**<br>
123+
If you have an existing ROOT installation on your system, this will interfere with the aliBuild installation, and will cause difficult-to-debug compilation errors.
124+
125+
Please uninstall any existing copy of ROOT on your system. The uninstallation method depends on how you installed it. For example, if you originally installed ROOT using Homebrew, you should uninstall it using `brew uninstall root`.
126+
127+
After uninstalling ROOT, remove any reference to ROOT from your `.zprofile`, `.zshrc` and any other shell configuration files. Then close and re-open your terminal window.
128+
129+
**Install the required packages**<br>
130+
131+
Note that Homebrew does not run as root. Do not prepend sudo to any of the following commands.
132+
133+
* Install the prerequisites and aliBuild via:<br>
134+
```brew install alisw/system-deps/o2-full-deps alisw/system-deps/alibuild```
135+
* Set up Homebrew in your shell by running the following command:<br>
136+
```echo 'eval "$(/opt/homebrew/bin/brew shellenv)"' >> ~/.zprofile```
137+
* Close Terminal and reopen it to apply changes.
138+
139+
140+
<h6 id="prereq-for-ubuntu">aliBuild prerequisites for Ubuntu</h6>
141+
142+
ALICE software on Ubuntu is supported on a best effort basis. There is no guarantee that software builds or runs correctly. Support requests might have low priority. We were able to successfully build on:
143+
144+
* Ubuntu 20.04 LTS
145+
* Ubuntu 22.04 LTS
146+
* Ubuntu 24.04 LTS
147+
148+
**Install required system packages**<br>
149+
150+
With root permissions, i.e. sudo, update your package sources:
151+
```bash
152+
sudo apt update -y
153+
```
154+
With root permissions, i.e. `sudo`, install the following packages:
155+
```bash
156+
sudo apt install -y curl libcurl4-gnutls-dev build-essential gfortran libmysqlclient-dev xorg-dev libglu1-mesa-dev libfftw3-dev libxml2-dev git unzip autoconf automake autopoint texinfo gettext libtool libtool-bin pkg-config bison flex libperl-dev libbz2-dev swig liblzma-dev libnanomsg-dev rsync lsb-release environment-modules libglfw3-dev libtbb-dev python3-dev python3-venv python3-pip graphviz libncurses-dev software-properties-common gtk-doc-tools
157+
```
158+
**Installing aliBuild**<br>
159+
160+
AliBuild, our build tool, is installed as a standard ubuntu package, provided you enable the alisw PPA repository. This is done with:
161+
162+
```bash
163+
sudo add-apt-repository ppa:alisw/ppa
164+
sudo apt update
165+
sudo apt install python3-alibuild
166+
```
167+
168+
<h6 id="prereq-for-fedora">aliBuild prerequisites for Fedora</h6>
169+
170+
With root permissions, i.e. `sudo` or as `root` install the prerequisites using:
171+
```bash
172+
yum install -y epel-release
173+
yum install -y dnf-plugins-core
174+
yum config-manager --set-enabled powertools
175+
yum update -y
176+
177+
dnf group install -y "Development Tools"
178+
179+
cat << EOF > /etc/yum.repos.d/alice-system-deps.repo
180+
[alice-system-deps]
181+
name=alice-system-deps
182+
baseurl=https://s3.cern.ch/swift/v1/alibuild-repo/RPMS/o2-full-deps_fedora.x86-64/
183+
enabled=1
184+
gpgcheck=0
185+
EOF
186+
yum update -y
187+
yum install -y alice-o2-full-deps alibuild
188+
```
189+
190+
### Configure aliBuild
191+
192+
After you are done installing alibuild you need to configure it by adding the two following lines to your ~/.bashrc, ~/.bash_profile, ~/.zshrc or ~/.zprofile (depending on your operating system and configuration):
193+
```bash
194+
export ALIBUILD_WORK_DIR="$HOME/alice/sw"
195+
eval "$(alienv shell-helper)"
196+
```
197+
The first line tells what directory is used as "build cache", the second line installs a "shell helper" that makes easier to run certain aliBuild-related commands.
198+
199+
You need to close and reopen your terminal for the change to be effective. The directory `~/alice/sw` will be created the first time you run aliBuild.
200+
201+
""Note that this directory tends to grow in size over time, and it is the one you need to remove in case of cleanups.""
202+
203+
When `aliBuild`is installed on your computer and your prerequisits are statisfied, you can move to the next step.
14204

15205
## Prepare your source code
16206

0 commit comments

Comments
 (0)