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
+31-10
Original file line number
Diff line number
Diff line change
@@ -23,8 +23,28 @@ Journal of Open Source Software by clicking the badge below:
23
23
24
24
## Getting started
25
25
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 *
(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,
28
48
[Python] packages (`matplotlib`, `numpy`, `scipy`, `shapely`, and `toml`).
29
49
30
50
### H trajectories and collision cascades in a boron nitride dust grain
@@ -107,7 +127,7 @@ The following features are implemented in `rustBCA`:
107
127
108
128
## Installation
109
129
110
-
Without optional features, `rustBCA` should compile with `cargo` alone on
130
+
Without optional features, `RustBCA` should compile with `cargo` alone on
111
131
Windows, MacOS, and Linux systems.
112
132
113
133
[HDF5] for particle list input has been tested on Windows, but version 1.10.6 must be used.
0 commit comments