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
📝 DOCS: Updates for compatibility with AiiDA v2.5.1 (#469)
This PR fixes some issues warnings that arose when going through the tutorials with AiiDA v2.5.1, mainly::
- Update the `verdi code setup` to `verdi code create` commands
- Update the SSSP version from 1.1 to 1.3 to reflect the change of default in `aiida-pseudo`
- Prepend `core` in the `DataFactory` calls where applicable, as well as `query.queryhelp` -> `query.as_dict()` in the `querying` notebook
Copy file name to clipboardExpand all lines: docs/sections/creating_plugins/example.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
# Interfacing with external codes - Example
4
4
5
-
**Task:** Follow the instructions on [writing a plugin for an external code](<https://aiida.readthedocs.io/projects/aiida-core/en/v2.0.3/howto/plugin_codes.html>).
5
+
**Task:** Follow the instructions on [writing a plugin for an external code](<https://aiida.readthedocs.io/projects/aiida-core/en/latest/howto/plugin_codes.html>).
6
6
7
7
**Result:** You will write a Python script with your first `CalcJob` and `Parser` plugin, telling AiiDA how to write inputs and parse outputs for a simple external executable.
This command sets up a code with *label*`add` on the *computer*`localhost`, using the *plugin*`core.arithmetic.add`.
@@ -432,7 +432,7 @@ $ verdi code list
432
432
* pk 1 - add@localhost
433
433
```
434
434
435
-
In the output above you can see a the code `add@localhost`, with PK = 1, in the printed list.
435
+
In the output above you can see the code `add@localhost`, with PK = 1, in the printed list.
436
436
Again, in your output you may have other codes listed or a different PK depending on your specific setup, but you should still be able to identify the code by its label.
437
437
The `add@localhost` identifier indicates that the code with label `add` is run on the computer with label `localhost`.
438
438
To see more details about the computer, you can use the following `verdi` command:
Copy file name to clipboardExpand all lines: docs/sections/running_processes/basics.md
+8-8Lines changed: 8 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -115,7 +115,7 @@ You will notice that the information that goes into the `test_run.in` input file
115
115
* the `UpfData` node with link label `pseudos_Si` contains the data for the *ATOMIC_SPECIES* block (including the pseudopotential file to be copied in the `pseudo_dir`).
116
116
* the `Dict` node with link label `parameters` contains the rest of the data (for the *&CONTROL* and *&SYSTEM* namelists).
117
117
118
-
Once the inputs files are prepared from these nodes, they are copied into the computer or cluster where the calculation will run.
118
+
Once the input files are prepared from these nodes, they are copied into the computer or cluster where the calculation will run.
119
119
AiiDA immediately generates a `RemoteData` node as part of this submission procedure; this node can be thought as a symbolic link to the remote folder where the files are copied.
120
120
121
121
The other output nodes are created once the calculation has finished, after the retrieval and parsing steps.
@@ -160,7 +160,7 @@ However, you will still have to set up the code to run it with AiiDA.
Copy file name to clipboardExpand all lines: docs/sections/running_processes/errors.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -54,7 +54,7 @@ For the `structure` you can download the following {download}`silicon crystal<in
54
54
If you have already done so previously (as it is used in other tutorial sections), you may want to use that pre-existing node instead of saving a new node with repeated information.
55
55
To do so you may search for its PK by running `verdi data core.structure list` and then use the function `load_node()` to retrieve it.
56
56
57
-
For the `pseudos` (or [pseudopotentials](https://en.wikipedia.org/wiki/Pseudopotential)), you can use the `SSSP/1.1/PBE/efficiency` family of the `aiida-pseudo` package.
57
+
For the `pseudos` (or [pseudopotentials](https://en.wikipedia.org/wiki/Pseudopotential)), you can use the `SSSP/1.3/PBE/efficiency` family of the `aiida-pseudo` package.
58
58
If you already have it installed, it is enough to use the `load_group()` function and then the `get_pseudos()` method of the loaded pseudo group.
59
59
60
60
The set of `kpoints` can be simply created by using the methods of the `KpointsData` node class to define a `2x2x2` mesh and store it in a new node.
Copy file name to clipboardExpand all lines: docs/sections/writing_workflows/errors.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -40,7 +40,7 @@ This exit code is used in the `validate_result` step, where the sum produced by
40
40
41
41
```
42
42
43
-
If the sum is negative, which is unacceptable in this fictitious example, the work chain return the exit code that corresponds to the label `ERROR_NEGATIVE_NUMBER`.
43
+
If the sum is negative, which is unacceptable in this fictitious example, the work chain returns the exit code that corresponds to the label `ERROR_NEGATIVE_NUMBER`.
44
44
Note that you can use the `self.exit_codes` property of the `WorkChain` to quickly retrieve the exit code using the corresponding label.
45
45
Returning an exit code instructs the engine to abort the work chain, and set the corresponding exit status and message on the node in the provenance graph.
Copy file name to clipboardExpand all lines: docs/sections/writing_workflows/realworld.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -32,10 +32,10 @@ $ verdi code list
32
32
* pk 74 - pw@localhost # <- this is the relevant code
33
33
```
34
34
35
-
If you don't have the PW code available, you can set it up by running the following command (you may need to adapt the `--remote-abs-path` or even the `--computer` if you are running in a custom environment):
35
+
If you don't have the PW code available, you can set it up by running the following command (you may need to adapt the `--filepath-executable` or even the `--computer` if you are running in a custom environment):
0 commit comments