.. _install:

Installing WEASEL
=================


WEASEL is distributed as an archive ``weasel-<version>.tar.xz``. In this
archive resides a directory (e.g. ``weasel-1.11``) containing the main
executable (``weasel``) and a simple wrapper for submitting WEASEL
jobs to Slurm (``subweasel``), as well as a README, changelog,
libraries, config and example files in subdirectories.

It is currently available as a Linux-version only, including a full
installation of ORCA and OpenMPI.


.. note::
   For detailed  instructions, in particular for installation on remote systems,
   check the specific page :ref:`here<detailedinstall>`.

.. _MandatorySettings:

Mandatory Settings
------------------

Weasel requires information about the hardware
architecture, in particular the number of processors and memory.

The installation archive provides a minimal sample configuration file
``settings/minimal-settings-1.11.ini.sample`` which contains all
mandatory settings with explanatory comments. For more information on
settings files, see :ref:`settingsFiles`::

       [HARDWARE]
       # Memory in MiB available per core.
       # Example: If 4 cores (pal4) are used and in total 32000 MB RAM
       #          are available, Memory should be set to 8000
       Memory = 2500
       # Number of cores to be used for parallel jobs
       Cores = 2

Weasel looks for those settings in a *system-wide* and *user-specific* settings file:

* System: ``/etc/weasel/settings-1.11.ini``
* User: ``~/.config/weasel/settings-1.11.ini``

while the latter takes precedence. The former is more suitable for
per-machine installation by the system administrator while the latter
for a per-user installation.

.. note::

   Note, the path of the system settings file ``/etc/weasel/settings-1.11.ini``
   can be customized by the environment variable ``WEASEL_SYSTEM_SETTINGS``.

License file
------------

WEASEL requires a valid license for working. If you did not receive a
copy please contact support@faccts.de.

WEASEL looks for the license file in the following locations and uses
the first one it finds:

* Path given by environmental variable ``WEASEL_LICENSE_FILE``
* ``WEASEL.lic`` in current directory
* ``~/.config/weasel/WEASEL-1.11.lic``
* ``/etc/weasel/WEASEL-1.11.lic``