diff --git a/gadget/4.0/README.md b/gadget/4.0/README.md index 43cff1289d114a805291d607e720263cb8b02265..0ddae683606e0d800e98c65f8032602972086ed5 100644 --- a/gadget/4.0/README.md +++ b/gadget/4.0/README.md @@ -40,21 +40,21 @@ Source code used in the benchmarks (version of June 22, 2021) [./gadget/4.0/gadg There are two files to obtain from the repository: gadget4.tar.gz and example_ics.tar.gz -gadget4.tar.gz includes the source code, examples, buildsystem, and documentation folders. It also includes Makefile and Makefile.systype (or a template) +gadget4.tar.gz includes the `src` code, `examples`, `buildsystem`, and `documentation` folders. It also includes **Makefile** and **Makefile.systype** (or a template) -example_ics.tar.gz includes initial conditions that are needed for each of the examples. When untarred you generate a folder named ExampleICs. You may download the examples initial conditions from [./gadget/4.0/example_ics.tar.gz](./gadget/4.0/example_ics.tar.gz) +example_ics.tar.gz includes initial conditions that are needed for each of the examples. When untarred you generate a folder named `ExampleICs`. You may download the examples initial conditions from [./gadget/4.0/example_ics.tar.gz](./gadget/4.0/example_ics.tar.gz) -1. After decompressing gadget4.tar.gz go to the master folder named gadget4. There are two files that need modification: Makefile.systype and Makefile. +1. After decompressing gadget4.tar.gz go to the master folder named `gadget4`. There are two files that need modification: **Makefile.systype** and **Makefile**. -a) In the Makefile.systype select one of the system types by uncommenting the corresponding line or add a line with your system, e.g., +1. In the **Makefile.systype** select one of the system types by uncommenting the corresponding line or add a line with your system, e.g., ``` #SYSTYPE="XXX-BBB" ``` where XXX = system name and BBB = whatever you may want to include here, e.g., impi, openmpi, etc. -b) In case you uncommented a line corresponding to your system in the Makefile.systype then there is nothing to do in the Makefile. +1. In case you uncommented a line corresponding to your system in the **Makefile.systype** then there is nothing to do in the **Makefile**. -c) In case you added a line, say #SYSTYPE="XXX-BBB", into the Makefile.systype then you must modify the Makefile by adding the following lines in 'define available Systems' +1. In case you added a line, say #SYSTYPE="XXX-BBB", into the **Makefile.systype** then you must modify the **Makefile** by adding the following lines in 'define available Systems' ``` ifeq ($(SYSTYPE),"XXX-BBB") @@ -63,9 +63,9 @@ include buildsystem/Makefile.path.XXX-BBB endif ``` -2. In the folder buildsystem make sure you have the Makefile.comp.XXX and Makefile.path.XXX (XXX = cluster name) set with the proper paths and compilation options, respectively. Either chose the existing files or create new ones that reflect your system paths and compiler. +2. In the folder `buildsystem` make sure you have the **Makefile.comp.XXX** and **Makefile.path.XXX** (XXX = cluster name) set with the proper paths and compilation options, respectively. Either chose the existing files or create new ones that reflect your system paths and compiler. -3. The folder examples has several subfolders of test cases. From one of these subfolders, e.g., CollidingGalaxiesSFR, copy Config.sh to the master folder. +3. The folder examples has several subfolders of test cases. From one of these subfolders, e.g., `CollidingGalaxiesSFR`, copy **Config.sh** to the master folder. 4. In the master folder compile the code ``` @@ -73,9 +73,9 @@ make CONFIG=Config.sh EXEC=gadget4-exe ``` where EXEC is the name of the executable. -5. Create a folder named `Run_CollidingGalaxies`. Copy gadget4-exe, and the files param.txt and TREECOOL existing in the subfolder CollidingGalaxiesSFR to `Run_CollidingGalaxies`. +5. Create a folder named `Run_CollidingGalaxies`. Copy **gadget4-exe**, and the files **param.txt** and **TREECOOL** existing in the subfolder `CollidingGalaxiesSFR` to `Run_CollidingGalaxies`. -6. In the folder `Run_CollidingGalaxies` modify param.txt to include the adequate path to the initial conditions file ics_collision_g4.dat located in the folder ExampleICs and modify the memory per core to that of the system you are using. +6. In the folder `Run_CollidingGalaxies` modify **param.txt** to include the adequate path to the initial conditions file **ics_collision_g4.dat** located in the folder `ExampleICs` and modify the memory per core to that of the system you are using. 7. Run the code using mpirun or submit a SLURM script.