FYS3150/Project-4
3
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update README

Browse Source
This commit is contained in:
Cory Balaton 2023-12-05 19:32:32 +01:00
parent bb36d42760
commit 53900b1205
No known key found for this signature in database
GPG Key ID: 3E5FCEBFD80F432B
2 changed files with 7 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Doxyfile
View File

@ -1237,7 +1237,7 @@ VERBATIM_HEADERS = YES
# generated with the -Duse_libclang=ON option for CMake.
# The default value is: NO.
CLANG_ASSISTED_PARSING = YES
CLANG_ASSISTED_PARSING = NO
# If the CLANG_ASSISTED_PARSING tag is set to YES and the CLANG_ADD_INC_PATHS
# tag is set to YES then doxygen will add the directory of each input to the

12
README.md
View File

@ -45,7 +45,7 @@ Compiling regular binaries is as easy as running this command:
make
```
The binaries will then be inside the **./bin** directory.
The binaries will then be inside the **bin** directory.
### Profiling binaries
@ -55,7 +55,7 @@ If you want to profile the programs (specifically the MPI program), then run thi
make profile
```
The binaries will then be inside the **./prof** directory.
The binaries will then be inside the **prof** directory.
### Debugging binaries
@ -65,7 +65,7 @@ If you want to debug the code, then use this command:
make debug
```
The binaries will then be inside the **./debug** directory.
The binaries will then be inside the **debug** directory.
## Running programs
@ -113,10 +113,10 @@ If you have any problems running the scripts, you might have to run this instead
### Batch system
For the **phase_transition_mpi** program, there are scripts in the **./slurm_scripts**
For the **phase_transition_mpi** program, there are scripts in the **slurm_scripts**
directory that come along with it. This is to be able to run it on a
batch system using Slurm if you have access to one.
The only program that should be executed by the user is the **./slurm_scripts/execute.script**
The only program that should be executed by the user is the **slurm_scripts/execute.script**
script. You can see how to use this script by doing:
```shell
@ -139,7 +139,7 @@ this repo on that system, then compile the MPI program like this:
make bin/phase_transition_mpi
```
After compiling, you can schedule it by using the **./slurm_scripts/execute.script**:
After compiling, you can schedule it by using the **slurm_scripts/execute.script**:
```shell
./slurm_scripts/execute.script <parameters>