Skip to content

Commit bc45f69

Browse files
cnyehWentzell
authored andcommitted
Add comments to CoQui notebooks
1 parent 53078bc commit bc45f69

File tree

1 file changed

+3
-2
lines changed

1 file changed

+3
-2
lines changed

CoQui/01_dft_to_coqui_converter.ipynb

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -74,7 +74,7 @@
7474
" <img src=\"./images/coqui_dft_converter.png\" alt=\"Workflow of input preparation for CoQuí\" width=\"60%\"> \n",
7575
"</figure>\n",
7676
"\n",
77-
"Here we show how to convert the Quantum ESPRESSO (QE) outputs into a format recognized by CoQuí using the customized converter **`pw2coqui.x`** which is shipped with QE. \n",
77+
"Here we show how to convert the Quantum ESPRESSO (QE) outputs into a format recognized by CoQuí using the [customized converter **`pw2coqui.x`**](https://github.com/AbInitioQHub/coqui/tree/examples/qe_converter). \n",
7878
"\n",
7979
"### ↔️ Running the QE converter \n",
8080
"Starting from a finished QE scf/nscf run, execute the converter: \n",
@@ -102,7 +102,8 @@
102102
"Together, these two pieces form the **complete CoQuí input**.\n",
103103
"\n",
104104
"> ⚠️ **Important** \n",
105-
"> Do **not** delete or move the {prefix}.save/ tree after conversion. CoQuí needs both the lightweight .coqui.h5 metadata file and the heavy orbital data in {prefix}.save/. Removing either will break subsequent steps."
105+
"> Do **not** delete or move the {prefix}.save/ tree after conversion. CoQuí needs both the lightweight .coqui.h5 metadata file and the heavy orbital data in {prefix}.save/. Removing either will break subsequent steps. \n",
106+
"> ⏱️ **Note:** Due to the interest of time, we will **not** run the QE converter in the following tutorials. A pre-generated `.h5` file will be provided instead."
106107
]
107108
},
108109
{

0 commit comments

Comments
 (0)