Find below instructions to install/update the VSoil software suite for Linux Ubuntu/Debian operating systems family.

1 - Connect to the vsoil repository

1.1 - Stable version

To connect to the vsoil repository, stable version, you need to follow the instructions below. Notice: this step is needed only once.

Type in a shell terminal (or by simple copy/paste by mouse):

sudo apt-get install --yes wget && wget -O ./bootstrap.sh "https://vsoil.inrae.fr/repo/linux/bootstrap.sh" && sudo /bin/bash ./bootstrap.sh && /bin/rm -f ./bootstrap.sh

If you get an error during the post-installation step, this should be caused by an access problem on a repository, potentially different from VSoil. In this case, there should be an output message like "W: Some index files failed to download. They have been ignored, or old ones used instead." If so, you should identify the website causing the problem and comment/remove it from your sources.list file located in /etc/apt directory. If in doubt, contact your system administrator.

1.2 - Testing version

If you want to test latest unstable VSoil packages, you can activate the vsoil-testing branch repository. To enable it, follow the instructions below.

Type in a shell terminal (or by simple copy/paste by mouse):

sudo apt-get install --yes vsoil-testing-apt-source

To disable this branch repository, just remove the package. To do this, follow the instructions below.

Type in a shell terminal (or by simple copy/paste by mouse):

sudo apt-get remove --yes vsoil-testing-apt-source

2 - Install the VSoil software suite

2.1 - On a local computer

Prerequisites: be connected to the vsoil repository, as described in the section "1 - Connect to the vsoil repository" above.

To use VSoil software and run VSoil models on your local computer, follow the instructions below. Notice: this will install all recommended extra software. In particular: C++ and Fortran compilers, R and some of its packages, some libraries (Blas, Lapack, Gimli).

Type in a shell terminal (or by simple copy/paste by mouse):

sudo apt-get install --install-recommends vsoil

2.2 - To run VSoil models on a distant server

To use VSoil software on your local computer but run VSoil models on a distant server, there are 4 steps.

On your local computer

The first step is to install VSoil on your local computer. If on Linux, see previous section ("2.1 - On a local computer"). If on Windows, see the dedicated web page.

On the server side

The second step is on the server side. It involves installing the needed software to run VSoil models. Prerequisites: on the server side, be connected to the vsoil repository (see section "1- Connect to the vsoil repository" above). Then follow the instructions below.

Type in a shell terminal (or by simple copy/paste by mouse):

sudo apt-get install --install-recommends vsoil-run singularity-ce

Then, you need the server to accept SSH connections. So the third step consists in installing the SSH server, on the server side. Follow the instructions below.

Type in a shell terminal (or by simple copy/paste by mouse):

sudo apt-get install openssh-server

Finally, in a fourth step, you need a user on the server to run the models, via the SSH connection. The easiest way is to create, on the server side, a dedicated user with the same login name as your local computer login name. You can type the following command, replacing the string MY_LOGIN_NAME. Notice: be concise and avoid spaces or special characters.

Type in a shell terminal (or by simple copy/paste by mouse):

sudo adduser MY_LOGIN_NAME

3 - Use a VSoil software

To use a VSoil software, you can invoke it by selecting its icon, as usual, on your operating system. Typically, this is done by entering a menu containing all applications, it depends on your graphical environment. As an alternative, you can type its name in a shell. See below for details.

On KDE environment, VSoil software are in the "K" menu (by default on the bottom side of your desktop screen) then "Applications", then "Science and mathematics". An easier way to find a VSoil software is to use the dedicated text-field "Find" in the "K" menu or by using the key shortcut "Alt+F2".

On Gnome environment, VSoil software are in the "Applications" menu (by default on the top side of your desktop screen) then "Science".

With command line interface, use the concerned VSoil application. Type in a shell terminal (or by simple copy/paste by mouse): vsoil_processes or vsoil_modules or vsoil_models or vsoil_player.

4 - Upgrade the VSoil software suite

It is advisable to update the VSoil software suite regularly. Firstly, because major updates are regularly scheduled by the project team, approximatively every year. These updates include new features and additional (or updated) processes, skeletons, modules and models. The second reason is that there should be some bug fixes and security patches in the software. This can happen at any time between two major updates.

Just ask your operating system to do so as usual if you know how to do. Otherwise execute the following instructions, depending on your environment.

To update the package database and upgrade all packages, type in a shell terminal (or by simple copy/paste by mouse):

sudo apt-get update && sudo apt-get upgrade --with-new-pkgs

The system will upgrade automatically all installed software to their latest version. If in doubt, ask your system administrator.