Getting Started
===============

Quickstart
----------

DynPSets and its dependencies can be installed into a dedicated environment using the `DynPkgs package manager <https://dynres-dynpkgs.readthedocs.io/en/latest/>`__:


.. code-block:: console
   
   user@host:~# dynpkgs env_install dyn_psets


After successful installation, deploy the dyn_psets environment ...

.. code-block:: console
   
   user@host:~# dynpkgs env_deploy [--nodes=NUM_NODES] dyn_psets

DynPSets environment is now available in your shell (indicated by (dyn_rm) shell prefix). Refer to the :ref:`usage` section for information on how to use DynPSets.

.. code-block:: console
   
   (dyn_psets) user@host:~# use_dynpsets

To exit the environemnt simply exit the current shell:

.. code-block:: console
   
   (dyn_psets) user@host:~# exit


Manual Installation
-------------------

Prerequisites::

- Open-MPI with DPP: https://gitlab.inria.fr/dynres/dyn-procs/ompi

The library can be installed with autotools. In the project directory:

1. Run autogen::

    ./autogen.sh

2. Run configure (optionally specify an install prefix and the path to MPI)::

    ./configure [--prefix=/path/to/install-dir] [--with-mpi=/path/to/mpi]

3. Build and install::

    make && make install