Skip to content

Commit d87a41b

Browse files
authored
Update README.md
1 parent 9c27c50 commit d87a41b

File tree

1 file changed

+31
-10
lines changed

1 file changed

+31
-10
lines changed

README.md

+31-10
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,28 @@ Journal of Open Source Software by clicking the badge below:
2323

2424
## Getting started
2525

26-
For those eager to get started, try running one of the examples in the
27-
`rustBCA` directory. Note that to automatically manipulate input files and reproduce the plots located on the [Wiki], these require several optional, but common,
26+
The easiest way to get started is with the ergonomic Python functions currently on the development branch. Follow these steps to install, build, and run simple RustBCA simulations for sputtering yields and reflection coefficients:
27+
```
28+
git clone https://github.com/lcpp-org/rustbca
29+
cd rustbca
30+
git checkout dev
31+
python -m pip install .
32+
python
33+
Python 3.9.6 (tags/v3.9.6:db3ff76, Jun 28 2021, 15:26:21) [MSC v.1929 64 bit (AMD64)] on win32
34+
Type "help", "copyright", "credits" or "license" for more information.
35+
>>> from libRustBCA.pybca import *; from scripts.materials import *
36+
>>> angle = 0.0 # deg
37+
>>> energy = 1000.0 # eV
38+
>>> num_samples = 10000
39+
>>> sputtering_yield(argon, tungsten, energy, angle, num_samples)
40+
1.0398
41+
>>> reflection_coefficient(argon, tungsten, energy, angle, num_samples)
42+
(0.3294, 0.10230906775743769) # (reflection coefficient, energy reflection coefficient)
43+
>>>
44+
```
45+
46+
For those eager to get started with the standalone code, try running one of the examples in the
47+
`RustBCA/examples` directory. Note that to automatically manipulate input files and reproduce the plots located on the [Wiki], these require several optional, but common,
2848
[Python] packages (`matplotlib`, `numpy`, `scipy`, `shapely`, and `toml`).
2949

3050
### H trajectories and collision cascades in a boron nitride dust grain
@@ -107,7 +127,7 @@ The following features are implemented in `rustBCA`:
107127

108128
## Installation
109129

110-
Without optional features, `rustBCA` should compile with `cargo` alone on
130+
Without optional features, `RustBCA` should compile with `cargo` alone on
111131
Windows, MacOS, and Linux systems.
112132

113133
[HDF5] for particle list input has been tested on Windows, but version 1.10.6 must be used.
@@ -166,7 +186,7 @@ sudo apt-get install gcc gfortran build-essential cmake liblapack-dev libblas-de
166186
```bash
167187
sudo apt-get install cargo
168188
```
169-
9. Build `rustBCA`:
189+
9. Build `RustBCA`:
170190
```bash
171191
git clone https://github.com/lcpp-org/rustBCA
172192
cd rustBCA
@@ -216,7 +236,7 @@ If the [rcpr] is desired, it's probably also a good idea to install the followin
216236
sudo dnf install gcc gcc-gfortran cmake lapack lapack-devel blas blas-devel
217237
```
218238

219-
Building `rustBCA` is straightforward and can be done using:
239+
Building `RustBCA` is straightforward, and can be done using:
220240

221241
```bash
222242
git clone https://github.com/lcpp-org/rustBCA
@@ -229,20 +249,21 @@ automatically during the build.
229249

230250
## Usage
231251

232-
To use `rustBCA`, modify the `input.toml` file, which is used to configure each
252+
To use `RustBCA`, modify the `input.toml` file, which is used to configure each
233253
simulation.
234254
To run a simulation, execute:
235255

236256
```bash
237-
./rustBCA
257+
./RustBCA
238258
```
239259

240-
with `input.toml` in the same directory as `rustBCA`.
241-
Alternatively, `rustBCA` accepts the name of a`.toml` input file as a single
260+
with `input.toml` in the same directory as `RustBCA`.
261+
Alternatively, `RustBCA` accepts the name of a`.toml` input file as a single
242262
command line argument:
243263

244264
```bash
245-
./rustBCA /path/to/input.toml
265+
./
266+
RustBCA /path/to/input.toml
246267
```
247268

248269
For further details, have a look at

0 commit comments

Comments
 (0)