Skip to content

Commit 1b3cd5f

Browse files
committed
add quick start to readme
1 parent ef7e5b1 commit 1b3cd5f

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

Lines changed: 18 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,3 +12,21 @@
1212
- Version 0.7.x is reserved
1313
- Version 0.8.x and onwards provides a new and much more flexible implementation, and integrates with the [AtomsBase](https://github.com/JuliaMolSim/AtomsBase.jl) ecosystem. Most but not all features from 0.6.x have been ported to this re-implementation. Usability should be the same or improved for most end-users. For developers this provides a much more flexible framework for experimentation. [[docs-v0.8]](https://acesuit.github.io/ACEpotentials.jl/dev/)
1414

15+
16+
## Quick Start
17+
18+
- Install Julia 1.10
19+
- Create new folder a.g. `acetutorial`; Open a shell
20+
- Create a new project in `acetutorial` and install `ACEpotentials.jl`
21+
```
22+
julia --project=.
23+
]
24+
registry add https://github.com/ACEsuit/ACEregistry
25+
add ACEpotentials
26+
```
27+
- Install the Julia tutorials (this installs two Jupyter notebook tutorials)
28+
```julia-repl
29+
using ACEpotentials
30+
ACEpotentials.copy_tutorial()
31+
```
32+
- Work through the tutorials.

0 commit comments

Comments
 (0)