Skip to content

Commit 1982f6f

Browse files
committed
Readme updates - clarify ergonomic functions
1 parent 064a9f9 commit 1982f6f

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ and displacement damage of the target. Generally, [BCA] codes can be
1515
valid for incident ion energies between approximately ~1 eV/nucleon
1616
to <1 GeV/nucleon. Improvements to RustBCA have expanded the regime
1717
of validity for some quantities, such as reflection coefficients, below
18-
1 eV/nucleon.
18+
1 eV/nucleon for some ion/target pairs.
1919

2020
Check out the `RustBCA` [Wiki] for detailed information, installation
2121
instructions, use cases, examples, and more. See the RustBCA paper at the
@@ -35,6 +35,8 @@ Selected citations of RustBCA as of 5/24/23:
3535
## Getting started
3636

3737
The easiest way to get started is with the ergonomic Python functions.
38+
These functions use the default RustBCA options detailed on the [Input Files](https://github.com/lcpp-org/RustBCA/wiki/Standalone-Code:-Input-File) page, which are not universally applicable.
39+
These examples use example material parameters located in `scripts/materials.py` which should be verified before use.
3840
Follow these steps to install, build, and run simple RustBCA simulations
3941
for sputtering yields and reflection coefficients:
4042
```

0 commit comments

Comments
 (0)