Skip to content

Commit

Permalink
Adjust guide
Browse files Browse the repository at this point in the history
  • Loading branch information
edan-bainglass committed Jan 12, 2025
1 parent 1c986e1 commit 80eedd7
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 13 deletions.
30 changes: 18 additions & 12 deletions src/aiidalab_qe/guides/0_basic.html
Original file line number Diff line number Diff line change
Expand Up @@ -189,24 +189,27 @@ <h4>Tasks</h4>
Here in the results panel, each tab will open results pertaining to a specific
calculation submitted by the workflow.
<div class="alert alert-success">
See further instructions below in the <b>Structure</b> tab.
See further instructions below in the <b>Relaxed structure</b> tab.
</div>
</div>

<div id="structure-results">
In the structure results panel, we can view the initial structure selected for
the calculation. The panel is mostly the same as the one we saw in the
structure selection step, with the notable additions of the structure node
info and structure coordinates table. Most importantly, once the structure
relaxation is complete, the toggle button below the title will become active
and allow us to switch between the initial and relaxed structure.
When the calculation is finished, the <b>Load results</b> button will become
active, allowing us to load the relaxation results from AiiDA. The loaded
panel is mostly the same as the one we saw in the structure selection step,
with the notable additions of the structure node info and structure
coordinates table.
<div class="alert alert-success">
<h4>Tasks</h4>
<ol>
<li>When active, click on <b>Load results</b></li>
<li>
Note the differences in cell parameters (vector lengths/angles and
volume) and atomic positions
</li>
<li>
Once the calculation is complete, click on the toggle button to switch
between the structure views. Note the differences in cell parameters
(vector lengths/angles and volume) and atomic positions
Compare the results against the initial structure in the structure
selection step at the top of the app
</li>
<li>
When ready, switch over to the <b>Electronic bands + PDOS </b> panel
Expand Down Expand Up @@ -251,13 +254,16 @@ <h4>Tasks</h4>
<div id="post-guide">
<h4>Post-guide exercises</h4>
<ol>
<li>Download the raw input and output files for further analysis</li>
<li>Switch back to the <b>Summary</b> panel of the results step</li>
<li>Download the raw data (.zip file) for further analysis</li>
<div class="alert alert-info">
This will download a folder hierarchy with all inputs and outputs of
calculations submitted by the workflow, allowing you to dig deeper into
the data without requiring an AiiDA installation.
</div>
<li>Download the AiiDA archive to store the full calculation provenance</li>
<li>
Download the AiiDA archive including the full calculation provenance
</li>
<div class="alert alert-info">
The downloaded archive can be imported in any AiIDA/AiiDAlab instance,
reproducing the whole dataset as if it was computed on the platform where
Expand Down
2 changes: 1 addition & 1 deletion tests/test_infobox.py
Original file line number Diff line number Diff line change
Expand Up @@ -39,5 +39,5 @@ def test_in_app_guide():
assert in_app_guide.layout.display == "none"

guide_manager.active_guide = "general/basic"
in_app_guide = InAppGuide(identifier="guide-warning")
in_app_guide = InAppGuide(identifier="guide-header")
assert "You've activated the basic in-app guide" in in_app_guide.children[0].value

0 comments on commit 80eedd7

Please sign in to comment.