1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
|
# WarpX
Online documentation: https://ecp-warpx.github.io/index.html
## Overview
This repository is a project to build an **electromagnetic Particle-In-Cell (PIC) code** with mesh refinement, based on:
- The block-structure adaptive mesh refinement code [AMReX](https://bitbucket.org/berkeleylab/amrex)
- The highly-optimized PIC code PICSAR
- The Python interface of the code Warp
NB: [Regression tests](https://ccse.lbl.gov/pub/RegressionTesting/WarpX/) are run every night to check the validity of the code in this repository.
## Installation
### Downloading the code
You should clone the source codes of AMReX, PICSAR and WarpX into one single directory (e.g. `warpx_directory`):
```
mkdir warpx_directory
cd warpx_directory
git clone https://bitbucket.org/berkeleylab/warpx.git
git clone https://bitbucket.org/berkeleylab/picsar.git
git clone https://github.com/AMReX-Codes/amrex.git
```
You should then switch to the branch `development` of AMReX
```
cd amrex/
git checkout development
cd ..
```
### Compiling the code
`cd` into the the directory `warpx` and type
```
make -j 4
```
In this case, OpenMP is enabled by default. In order to disable OpenMP:
```
make -j 4 USE_OMP=FALSE
```
This will compile the code (using 4 procs for the compilation) and generate an executable file in the `Bin` directory.
In order to clean a previously compiled version:
```
make realclean
```
## Running the Langmuir tests
The folder `Example/Langmuir` contains code that allow the user
to run a Langmuir wave case with WarpX. The instructions below
explain how to do this.
### Running the test with Warpx
After compiling WarpX for (see the above instructions), copy the
compiled executable (its name starts with `main3d`) from the folder
`Bin/` to the folder
`Example/Langmuir/`. Then type
```
cd tests/Langmuir
mpirun -np 4 ./<executable_name> inputs
```
where `<executable_name>` should be replaced by the name of the
compiled executable.
The code produces a set of folders with names starting with `plt`.
### Running the test with PICSAR
`cd` into the folder `picsar` (`cd ../../../picsar` if you are
currently in the folder `test/Langmuir`), and type the following set
of commands:
```
make clean
make
cp fortran_bin/picsar ../warpx/tests/Langmuir/
cd ../warpx/tests/Langmuir/
./picsar
```
### Visualizing and comparing the results
The results are compared using Python, inside a Jupyter notebook. In
order to be able to visualize the results, you need to first install
the proper visualization software:
- If you are using the Anaconda distribution of Python, type:
```
conda install jupyter numpy yt matplotlib
```
- Otherwise, type:
```
pip install jupyter numpy yt matplotlib
```
Then, within the folder `tests/Langmuir`, type:
```
jupyter notebook Visualization.ipynb
```
and follow the instructions that will pop up in your browser.
## Running the regression test
In order to run the regression test:
- **Prepare your environment**: Create a new directory (outside of warpx_directory) where the regression tests will be run. Here this directory will be denoted `<regression_directory>`. Then do
```
cd <regression_directory>
cp <warpx_directory>/amrex/Tools/RegressionTesting/regtest.py ./
cp <warpx_directory>/warpx/Regression/WarpX-tests.ini ./
export PYTHONPATH=$PYTHONPATH:<warpx_directory>/amrex/Tools/RegressionTesting/
```
where `<regression_directory>` and `<warpx_directory>` should be replaced by the proper values for your environment. Then open the file `WarpX-tests.ini` and replace the section
```
[main]
testTopDir = /home/regtester/AMReX_RegTesting/rt-WarpX/
webTopDir = /home/regtester/AMReX_RegTesting/rt-WarpX/web
```
by
```
[main]
testTopDir = <warpx_directory>
webTopDir = <warpx_directory>/web
```
(using only full paths; not relative paths) and replace the section
```
[AMReX]
dir = /home/regtester/AMReX_RegTesting/amrex/
branch = development
[source]
dir = /home/regtester/AMReX_RegTesting/warpx/
branch = master
[extra-PICSAR]
dir = /home/regtester/AMReX_RegTesting/picsar/
branch = master
```
by
```
[AMReX]
dir = <warpx_directory>/amrex/
branch = development
[source]
dir = <warpx_directory>/warpx/
branch = master
[extra-PICSAR]
dir = <warpx_directory>/picsar/
branch = master
```
(again using only full paths; not relative paths)
- **Set the reference:** Type:
```
python regtest.py --amrex_git_hash <amrex_hash> --source_git_hash <warpx_hash> --extra_src_git_hash <picsar_hash> --make_benchmarks "Resetting benchmarks" WarpX-tests.ini
```
where `<amrex_hash>`, `<warpx_hash>` and `<picsar_hash>` correspond to the git
hash for the code that you wish to use as a reference (and are optional arguments.)
- **Run the tests for a particular commit and compare with the reference:** Modify the same section as above to point to the relevant commit, and type:
```
python regtest.py --amrex_git_hash <amrex_hash> --source_git_hash <warpx_hash> --extra_src_git_hash <picsar_hash> WarpX-tests.ini
```
where `<amrex_hash>`, `<warpx_hash>` and `<picsar_hash>` correspond to the git
hash for the code that you wish to test (and are optional arguments.)
|
