Skip to content

Commit

Permalink
Update notebook documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
edan-bainglass committed Feb 2, 2025
1 parent 9d68252 commit 60e7ec5
Showing 1 changed file with 25 additions and 4 deletions.
29 changes: 25 additions & 4 deletions examples.ipynb
Original file line number Diff line number Diff line change
@@ -1,14 +1,32 @@
{
"cells": [
{
"cell_type": "code",
"execution_count": null,
"metadata": {
"vscode": {
"languageId": "javascript"
}
},
"outputs": [],
"source": [
"%%javascript\n",
"IPython.OutputArea.prototype._should_scroll = function(lines) {\n",
" return false;\n",
"}\n",
"document.title='AiiDAlab QE | Import examples'"
]
},
{
"cell_type": "code",
"execution_count": null,
"metadata": {},
"outputs": [],
"source": [
"%%capture\n",
"from aiida import load_profile\n",
"\n",
"load_profile();"
"load_profile()"
]
},
{
Expand All @@ -17,6 +35,7 @@
"metadata": {},
"outputs": [],
"source": [
"%%capture\n",
"from aiidalab_widgets_base.utils.loaders import load_css\n",
"\n",
"load_css(css_path=\"src/aiidalab_qe/app/static/styles\")"
Expand All @@ -26,9 +45,11 @@
"cell_type": "markdown",
"metadata": {},
"source": [
"# Import example calculations\n",
"# AiiDAlab Quantum ESPRESSO - Example calculations\n",
"\n",
"We provide here a set of example calculations performed with the AiiDAlab Quantum ESPRESSO app for you to import into your AiiDA instance. Choose one or more examples to import, then click the **<span style=\"color: #4caf50;\"><i class=\"fa fa-download\"></i> Import</span>** button. A report on each import will be appended to the log below. Once imported, you can click the **<span style=\"color: #2196f3;\"><i class=\"fa fa-list\"></i> Calculation history</span>** button to view details of any given imported calculation and/or launch it in an instance of the app to view its inputs and outputs.\n",
"\n",
"We provide here a set of example calculations performed with the AiiDAlab Quantum ESPRESSO app for you to import into your AiiDA instance. You can choose one or more examples do import at a time. If you have any questions or issues with the examples, please open an issue in the [aiidalab-qe-examples](https://github.com/aiidalab/aiidalab-qe-examples) repository."
"If you have any questions or issues regarding the examples, please open an issue in the [aiidalab-qe-examples](https://github.com/aiidalab/aiidalab-qe-examples) repository.\n"
]
},
{
Expand All @@ -45,7 +66,7 @@
" archive_list=\"examples_list.txt\",\n",
" archives_dir=\"examples\",\n",
" logger={\n",
" \"placeholder\": \"Archive importing output will be shown here.\",\n",
" \"placeholder\": \"Archive import output will be shown here.\",\n",
" \"clear_on_import\": True,\n",
" },\n",
")\n",
Expand Down

0 comments on commit 60e7ec5

Please sign in to comment.