You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -134,6 +134,7 @@ The following features are implemented in `RustBCA`:
134
134
* nonlocal (Lindhard-Scharff),
135
135
* and equipartition
136
136
* Biersack-Varelas interpolation is also included for electronic stopping up to ~1 GeV/nucleon. Note that high energy physics beyond electronic stopping are not included, and that Biersack-Varelas may not be as accurate as other methods.
137
+
* A modified Biersack-Varelas form which includes an interpolation parameter, `c_i`, that can be used to better match available stopping data for the Bragg peak.
137
138
* Biersack-Haggmark treatment of high-energy free-flight paths between collisions can be included to greatly speed up high-energy simulations (i.e., by neglecting very small angle scattering).
138
139
* A wide range of interaction potentials are provided, including:
139
140
* the Kr-C, ZBL, Lenz-Jensen, and Moliere universal, screened-Coulomb potentials.
@@ -157,7 +158,8 @@ The following features are implemented in `RustBCA`:
157
158
* full trajectory tracking for both the incident ions and target atoms,
158
159
* and many other parameters such as position of origin of sputtered particles and energy loss along trajectories.
159
160
* Optionally, the code can produce energy-angle and implantation distributions when built with the `--features distributions` flag and disable space-intensive particle list output with `--features no_list_output`.
160
-
* Library functions for modeling ion reflection, implantation, and sputtering in C++/C, Python, and Fortran codes.
161
+
* Library functions for running RustBCA in-memory in C++/C, Python, and Fortran codes.
162
+
* A seeded PRNG such that RustBCA results are exactly reproducible on any machine for any number of threads
161
163
162
164
## Installation
163
165
@@ -170,8 +172,6 @@ cargo build --release
170
172
171
173
will add an executable at `target/release/`.
172
174
173
-
[HDF5] for particle list input has been tested on Windows, but version 1.10.6 must be used.
174
-
175
175
#### Manual Dependences
176
176
177
177
*[rustup], the [Rust] toolchain (includes `cargo`, the [Rust] package manager, `rustc`, the [Rust] compiler, and more).
@@ -182,7 +182,6 @@ will add an executable at `target/release/`.
182
182
183
183
#### Optional Dependencies
184
184
185
-
*[HDF5] libraries
186
185
* For manipulating input files and running associated scripts, the following are suggested:
187
186
*[Python] 3.6+
188
187
*[Python] libraries: `numpy`, `matplotlib`, `toml`, `shapely`, and `scipy`.
9.`input.toml` is the input file - see the [Input File](https://github.com/lcpp-org/RustBCA/wiki/Standalone-Code:-Input-File) page for more information
224
223
10. Run the required tests using:
@@ -284,7 +283,7 @@ Additionally, `RustBCA` accepts an input file type (one of: `0D`, `1D`, `2D`, `T
284
283
```bash
285
284
./RustBCA 0D /path/to/input.toml
286
285
```
287
-
**Warning: RustBCA defaults to the 2D triangular mesh input mode.** For more details, see [Input Files](https://github.com/lcpp-org/RustBCA/wiki/Standalone-Code:-Input-File).
286
+
**Note: RustBCA defaults to the 2D triangular mesh input mode.** For more details, see [Input Files](https://github.com/lcpp-org/RustBCA/wiki/Standalone-Code:-Input-File).
288
287
Also have a look at the examples on the [Wiki] to see some examples of RustBCA input files.
0 commit comments