# Project 2

## Practical information

- [Project](https://anderkve.github.io/FYS3150/book/projects/project2.html)

## Compile and run C++ programs

Compiling and linking is done using Make, make sure you are in the root directory. 

There are two ways of compiling the code. The first alternative is to change 
directory to `src/` and compile

```shell
    cd src && make
```

The second alternative does not involve changing directory to `src/`, use 
make in the projects root directory

```shell
    make code
```

You can run any of the compiled programs by changing directory to `src/`, then

```shell
    ./test_suite
    ./main
```


## Generate plots

To generate plots, you can do

```shell
python3 plot.py
```

and the plots will be saved inside [latex/images](latex/images).


## Generate documentation

For this project, we have used Doxygen to generate some nice and readable
documentation for the C++ code.

If you want to generate the documentation you can do

```shell
    make docs
```

in the project root, and the documentation will be made into the `docs/` 
directory.

## Generate project document

If you want to recompile the Pdf file, you can do

```shell
    make latex
```

and a Pdf file will be produced inside the `latex/` directory.
