Differences

This shows you the differences between two versions of the page.

Link to this comparison view

Next revision 		Previous revision
bam [2024/06/04 09:48]
theoastro created 		— (current)
Line 1: Line 1:
-**BAM** or **bam** is a code for numerical relativity (NR). The code can be used for a variety of NR simulations, such as binary black holes, binary neutron stars, black hole - neutron star binaries, neutron star collapse and gravitational wave collapse.\\ 
-According to a readme-file by Bernd Bruegmann 
-> bam is supposed to be 
-> - simple 
-> - light-weight, with just the basics that are needed to get the job done 
-> - a code that allows 2 to 10 people to collaborate 
  
-====== How to use BAM? ====== 
-Here we briefly explain, how you can use BAM. This is more of a "getting started", for a full tutorial, please follow the following link: [[bam:tutorial|BAM Tutorial]]. 
- 
-===== Getting started ===== 
-First you will have to install BAM. For that you either need access to the BAM git-repository or know someone who has access. For a more detailed review on how to clone and build BAM, please see [[bam:tutorial#git|Building BAM]]. 
- 
-Once build, navigate to the base directory (usually called BAM), which contains the Myconfig file. Here you will find two very important directories: "exe" and "src". You will mainly use "exe" if you want to run BAM and "src" if you want to mess with the source code. The source code is further discussed under [[#Inner_workings|Inner workings]]. 
- 
-To run BAM you need a par-file (a file with the .par extension). Example par-files are provided in the "par" directory, however, these are potentially outdated. For a detailed explanation on how to setup a par-file see [[bam:tutorial#par_files|par-file]]. 
- 
-Before you can run BAM however, you need to compile it. For that navigate to the base directory and call "make". You may need to disable the recompilation of Mathematica files, if you do not have Mathematica installed on your machine. After a successful compilation (which requires mpicc), you are now good to go to run your first NR simulation in BAM! 
- 
-For that you have a couple of options. Run it with MPI, OpenMP, both or neither. For that use either of the following commands (replacing myparfile.par with the name of your par-file): 
- 
-<code> 
-./bam myparfile.par # no parallelization 
-OMP_NUM_THREADS=8 ./bam myparfile.par -nt 8 # OpenMP with 8 threads 
-mpirun -np 4 ./bam myparfile.par # MPI with 4 processes 
-</code> 
- 
-If you are running BAM from the local machines in the university, make sure to nice your jobs (e.g. nice -19 ./bam myparfile.par). 
- 
-After the program has finished (and also during a run) you will find the output data in a sub-directory of "exe" of the name of your par-file (without the extension). There is 0-, 1- , 2-, and 3-dimensional output. To understand the output format better, please see [[bam:tutorial#output:BAM output]]. 
- 
-====== Inner workings ====== 
Last modified: le 2024/06/04 09:48

Page Tools