79 lines
1.3 KiB
Markdown
79 lines
1.3 KiB
Markdown
# 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 folder. To create executable files, run shell commands
|
|
|
|
```shell
|
|
cd src/
|
|
make
|
|
```
|
|
To run `script-name`
|
|
|
|
```shell
|
|
./main
|
|
```
|
|
|
|
There are two ways of compiling the code.
|
|
|
|
The first way is to go into the src directory and compile
|
|
|
|
```shell
|
|
cd src && make
|
|
```
|
|
|
|
or you could use make in the project directory
|
|
|
|
```shell
|
|
make code
|
|
```
|
|
|
|
and it will compile everything with you needing to move into **src**.
|
|
|
|
You can run any of the compiled programs by going into the src directory
|
|
and then doing
|
|
|
|
```shell
|
|
./program-name
|
|
```
|
|
|
|
|
|
## 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.
|