Skip to content

Commit 8267220

Browse files
authored
Update README.md
Update readme; add citations, fix a couple typos, and add details not yet added from previous upgrades to the code.
1 parent 5ff8957 commit 8267220

File tree

1 file changed

+18
-6
lines changed

1 file changed

+18
-6
lines changed

README.md

Lines changed: 18 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,13 @@ Journal of Open Source Software by clicking the badge below:
2121

2222
[![DOI](https://joss.theoj.org/papers/10.21105/joss.03298/status.svg)](https://doi.org/10.21105/joss.03298)
2323

24+
Selected citations of RustBCA as of 5/24/23:
25+
* [Simulation of liquid lithium divertor geometry using SOLPS-ITER](https://doi.org/10.1109/TPS.2022.3166402), JD Lore et al. (2022)
26+
* [Characterizing W sources in the all-W wall, all-RF WEST tokamak environment](https://doi.org/10.1088/1361-6587/ac8acc), CC Klepper et al. (2022)
27+
* [hPIC2: A hardware-accelerated, hybrid particle-in-cell code for dynamic plasma-material interactions](https://doi.org/10.1016/j.cpc.2022.108569), LT Meredith et al. (2023)
28+
* [Global sensitivity analysis of a coupled multiphysics model to predict surface evolution in fusion plasma–surface interactions](https://doi.org/10.1016/j.commatsci.2023.112229), P. Robbe et al. (2023)
29+
* [Modeling the effect of nitrogen recycling on the erosion and leakage of tungsten impurities from the SAS-VW divertor in DIII-D during nitrogen gas injection](https://doi.org/10.1016/j.nme.2022.101254), MS Parsons et al. (2023)
30+
2431
## Getting started
2532

2633
The easiest way to get started is with the ergonomic Python functions.
@@ -93,7 +100,7 @@ plt.show()
93100

94101
## Features
95102

96-
The following features are implemented in `rustBCA`:
103+
The following features are implemented in `RustBCA`:
97104

98105
* Ion-material interactions for all combinations of incident ion and target species.
99106
* Infinite, homogeneous targets (Mesh0D), Layered, finite-depth inhomogeneous targets (Mesh1D), arbitrary 2D composition through a triangular mesh (Mesh2D), homogeneous spherical geometry (Sphere) and homogeneous 3D triangular mesh geometry (TriMesh).
@@ -232,7 +239,7 @@ sudo dnf install python3-numpy python3-scipy python3-matplotlib python3-toml pyt
232239

233240
or, alternatively, using `pip3`.
234241

235-
If the [rcpr] is desired, it's probably also a good idea to install the following:
242+
If desired, RustBCA can be built with [rcpr] to simulate attractive-repuslive interaction potentials; rcpr requires (at least) the following:
236243

237244
```bash
238245
sudo dnf install gcc gcc-gfortran cmake lapack lapack-devel blas blas-devel
@@ -260,12 +267,17 @@ To run a simulation, execute:
260267
```
261268

262269
with `input.toml` in the same directory as `RustBCA`.
270+
263271
Alternatively, `RustBCA` accepts the name of a`.toml` input file as a single
264-
command line argument:
272+
command line argument.
273+
274+
```bash
275+
./RustBCA /path/to/input.toml
276+
```
265277

278+
Additionally, `RustBCA` accepts an input file type (one of: `0D`, `1D`, `2D`, `TRIMESH`, `SPHERE` - see the wiki for more details):
266279
```bash
267-
./
268-
RustBCA /path/to/input.toml
280+
./RustBCA 0D /path/to/input.toml
269281
```
270282

271283
For further details, have a look at
@@ -281,4 +293,4 @@ Also have a look at the examples on the [Wiki] for writing `.toml` input files.
281293
[rustup]: https://rustup.rs
282294
[Rust]: https://en.wikipedia.org/wiki/Rust_(programming_language)
283295
[TOML]: https://en.wikipedia.org/wiki/TOML
284-
[Wiki]: https://github.com/lcpp-org/RustBCA/wiki
296+
[Wiki]: https://github.com/lcpp-org/RustBCA/wiki

0 commit comments

Comments
 (0)