Skip to content
Snippets Groups Projects
Commit c2d52735 authored by Ammar Nejati's avatar Ammar Nejati
Browse files

Docs>Install or build>Install>Linux: Add instructions for the self-contained installer for Linux

parent bed0036c
No related branches found
No related tags found
1 merge request!864Produce a self-contained self-extracting package for BornAgain GUI on Linux
...@@ -7,6 +7,37 @@ weight = 30 ...@@ -7,6 +7,37 @@ weight = 30
BornAgain is available as a Debian/Ubuntu package at https://tracker.debian.org/pkg/bornagain. BornAgain is available as a Debian/Ubuntu package at https://tracker.debian.org/pkg/bornagain.
A self-contained binary installer is also produced for the major Linux distributions
and their derivatives (like Debian, Ubuntu, ArchLinux, Manjaro, Fedora) and can be
downloaded as a GitLab artifact.
The installer includes all the libraries required for BornAgain, its Python package ('wheel'),
plus additional libraries and plugins for the GUI. Note that the GUI is known to work on the
[X11 graphics platform](https://en.wikipedia.org/wiki/X_Window_System), but Wayland is not
tested yet; if you are using a Wayland platform, please let us know about your experience
with BornAgain.
The installer is self-extracting and does _not_ need any root permissions.
The installer (e.g., `BornAgain-1.19.79-Linux.sh`) can be used as follows
(here, installation root path is chosen to be `/tmp/ba`):
```
$ chmod +x BornAgain-1.19.79-Linux.sh # permit execution
$ ba_path='/tmp/ba'
$ mkdir $ba_path # make a deliberate installation path
$ ./BornAgain-1.19.79-Linux.sh --exclude-subdir --skip-license --prefix=$ba_path
```
and then, the GUI can be executed:
```
$ cd $ba_path
$ ./bin/bornagain
```
The installer provides also a small help for its options; use the following to obtain
a description of the available options:
```
$ BornAgain-1.19.79-Linux.sh --help
```
For other distributions, see [build instructions]({{% relref "installation/building/unix" %}}). For other distributions, see [build instructions]({{% relref "installation/building/unix" %}}).
{{% children %}} {{% children %}}
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment