Installation Guide
==================

Installing on Linux
-------------------

Firstly, download this git repository:

.. code-block:: bash

   git clone https://github.com/09nwalkerm/ROMpEIT.git

Next, make a directory in which you would like to keep the results generated by the toolbox.
Then navigate to the setup/ directoy in ROMpEIT and source the set_env.sh script to set some environment variables.
When prompted, add the path to the results folder you made. Then type "y" when asked to create a log folder.

.. code-block:: bash

   mkdir ROMpEIT_results
   cd ROMpEIT/setup/
   . set_env.sh

You're now ready to start matlab and use the toolbox or submit SLURM jobs. 
Please see the example.m script for an idea of the general workflow.

BLEIGIFP Installation
---------------------

It is highly recommended that you install the BLEIGIFP matlab code for solving generalised eigenvalue problems.
Make sure to add this function to your MATLAB path.
The code can be downloaded `here`_.

.. _here: https://www.ms.uky.edu/~qye/bleigifp.html