Quickstart
=====

Pre-requisites:

    * A Linux/Unix based OS

    * A Fortran compiler (preferably :code:`gfortran`), 
    
    * A Fortran-OpenMP installation

    * A HDF5 serial installation
    
    * A Python installation (if you want to use the pre-written post-processing scripts)

Now one can clone the GitHub repository to use the code.

:code:`git clone https://github.com/vicky1997/mcdust.git`

First run
+++++++++
#. Make the :code:`/setups/default` setup. The `make` should be run in the main `mcdust` directory.
    :code:`make SETUP_FILE=default`
#. Set the number of threads for OpenMP parallelisation.
    :code:`export OMP_NUM_THREADS=$OMP_NUM_THREADS`
#. Run the code
    | :code:`./default setups/default/setup.par`
#. To clear and start afresh
    :code:`make clean SETUP_FILE=default`

Restart
+++++++

To (re)start the simulation from a specific snapshot, follow the steps.

#. Copy the snapshot of your choice to the setup directory from where you want to restart
    :code:`cp your/data/directory/foo.h5 setups/restartrun/`
#. Rename the file to :code:`restart.h5`
    :code:`mv foo.h5 restart.h5`
#. Uncomment the `CFLAGS+=-D RESTART``flag by removing the `#` in front of it.

Unit tests
++++++++++

#. To run the unit tests module which is in :code:`unit_tests/testsuite.F90`
    :code:`make test SETUP_FILE=tests`
    
    :code:`./test1 setups/tests/setup.par`

#. To clear the run
    :code:`make cleantest SETUP_FILE=tests`