Skip to content

Commit 5a01d15

Browse files
authored
Update README.md
1 parent a038aea commit 5a01d15

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

README.md

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -71,7 +71,7 @@ plt.show()
7171
The following features are implemented in `rustBCA`:
7272

7373
* Ion-material interactions for all combinations of incident ion and target species.
74-
* Infinite, homogeneous targets (Mesh0D), Layered, finite-depth inhomogeneous targets (Mesh1D) and arbitrary 2D geometry and composition through a triangular mesh (Mesh2D).
74+
* Infinite, homogeneous targets (Mesh0D), Layered, finite-depth inhomogeneous targets (Mesh1D), arbitrary 2D geometry composition through a triangular mesh (Mesh2D), homogeneous spherical geometry (Sphere) and homogeneous, arbitrary triangular mesh geometry (TriMesh).
7575
* Amorphous Solid/Liquid targets, Gaseous targets, and targets with both solid/liquid and gaseous elements
7676
* Low energy (< 25 keV/nucleon) electronic stopping modes including:
7777
* local (Oen-Robinson),
@@ -94,17 +94,19 @@ The following features are implemented in `rustBCA`:
9494
* or the MAGIC algorithm.
9595
* Input files use the [TOML] format, making them both human-readable and easily parsable.
9696
* RustBCA generates user-friendly, context-providing error messages, which help pinpoint the cause of errors and provide suggested fixes to the user.
97-
* The simulation results are formatted as the ubiquitous `csv` format and include:
97+
* The simulation results are comma-delimited (`csv` format) and include:
9898
* the energies and directions of emitted particles (reflected ions and sputtered atoms),
9999
* the final positions of implanted ions,
100-
* and full trajectory tracking for both the incident ions and target atoms.
100+
* full trajectory tracking for both the incident ions and target atoms,
101+
* and many other parameters such as position of origin of sputtered particles and energy loss along trajectories.
101102
* 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`.
102103

103104
## Installation
104105

105106
Without optional features, `rustBCA` should compile with `cargo` alone on
106107
Windows, MacOS, and Linux systems.
107-
[HDF5] has been tested on Windows, but version 1.10.6 must be used.
108+
109+
[HDF5] for particle list input has been tested on Windows, but version 1.10.6 must be used.
108110
[rcpr], the adaptive Chebyshev Proxy Rootfinder with automatic subdivision and
109111
polynomial rootfinder package for [Rust], has not yet been successfully compiled
110112
on Windows.

0 commit comments

Comments
 (0)