Skip to content

Commit 05f67a7

Browse files
authored
Merge pull request ACEsuit#261 from ACEsuit/tutorial_08
WIP: Translate Chuck's Tutorial to 0.8
2 parents a720285 + 260cead commit 05f67a7

File tree

18 files changed

+1194
-79
lines changed

18 files changed

+1194
-79
lines changed

docs/make.jl

Lines changed: 0 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -71,12 +71,6 @@ makedocs(;
7171
"literate_tutorials/dataset_analysis.md",
7272
"tutorials/scripting.md",
7373
"literate_tutorials/descriptor.md",
74-
# "tutorials/lammps.md",
75-
# "tutorials/python_ase.md",
76-
# "tutorials/molly.md",
77-
# "literate_tutorials/committee.md",
78-
# "tutorials/AtomsBase_interface.md",
79-
# "literate_tutorials/experimental.md",
8074
],
8175
"Additional Topics" => Any[
8276
"gettingstarted/parallel-fitting.md",

docs/src/gettingstarted/installation.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,19 @@ Depending on your usage you may also need to add other packages, e.g. `AtomsBase
6565
When returning to a project, there are several methods for reactivating it. One is to simply `activate .` in the package manager, as above. Alternatively set the `JULIA_PROJECT` environment variable to the directory with `Project.toml` before starting julia, or call julia as `julia --project=<dir>`. Special syntax like `JULIA_PROJECT=@.` or `julia --project=@.` searches the current directory and its parents for a `Project.toml` file.
6666

6767

68+
### Setting up the tutorial
69+
70+
As in the instructions described above, install Julia, then create a new folder, start new julia project and in that project add `ACEpotentials` and `IJulia`, then copy the tutorial to the local folder:
71+
```
72+
julia -e 'using Pkg; Pkg.add("ACEpotentials"); Pkg.add("IJulia")'
73+
julia -e 'using ACEpotentials; ACEpotentials.copy_tutorial(@__DIR__())'
74+
```
75+
Start Jupyter, e.g. via
76+
```
77+
jupyter notebook
78+
```
79+
Open the tutorial notebook. If a Julia kernel can be selected make sure it is 1.10 or higher. The follow the instructions in the notebook.
80+
6881
### Setting up the Python ASE calculator
6982

7083
!!! warning

docs/src/tutorials/index.md

Lines changed: 0 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -7,36 +7,3 @@
77
* [Basic Dataset Analysis](../literate_tutorials/dataset_analysis.md) : basic techniques to visualize training datasets and correlate such observations to the choice of geometric priors
88
* [Descriptors](../literate_tutorials/descriptor.md) : `ACEpotentials` can be used as descriptors of atomic environments or structures, which is described here.
99

10-
11-
```@raw html
12-
<!-- ### Using `ACEpotentials` Potentials in External Software
13-
* [ACE descriptors](../literate_tutorials/descriptor.md)
14-
15-
16-
* [LAMMPS](lammps.md)
17-
* [Python with `ase`](python_ase.md)
18-
* [`Molly.jl`](molly.md) -->
19-
20-
<!-- ### Structure analysis with ACE1 descriptors
21-
22-
23-
### Committee Potentials
24-
25-
* [Committee Potentials](../literate_tutorials/committee.md)
26-
27-
### Experimental Features
28-
29-
* [Experimental Features](../literate_tutorials/experimental.md) -->
30-
```
31-
32-
```@raw html
33-
<!---
34-
### JSON Interface and Command line (OUTDATED)
35-
36-
ACE potentials can be fitted from the command line using a dictionary stored in a `.json` or `.yaml` file to specify the parameters:
37-
38-
* [TiAl Potential (ACEpotentials)](../literate_tutorials/ACEpotentials_TiAl.md)
39-
* [TiAl Potential (command line JSON)](../outdated/first_example_json.md)
40-
41-
-->
42-
```
File renamed without changes.
File renamed without changes.
File renamed without changes.

0 commit comments

Comments
 (0)