Skip to content

Commit

Permalink
SOF-7063: split into sections, add screenshots
Browse files Browse the repository at this point in the history
  • Loading branch information
pranabdas committed Dec 21, 2023
1 parent 16256d7 commit 47f15b7
Show file tree
Hide file tree
Showing 11 changed files with 65 additions and 18 deletions.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file added images/tutorials/hubbard/hubbard-09-result.webp
Binary file not shown.
2 changes: 1 addition & 1 deletion lang/en/docs/tutorials/dft/electronic/hubbard.json
Original file line number Diff line number Diff line change
Expand Up @@ -149,5 +149,5 @@
"endTime": "00:01:31.000"
}
],
"youTubeId": "Uh9OWJHKlQY"
"youTubeId": "33PykNO8QlQ"
}
81 changes: 64 additions & 17 deletions lang/en/docs/tutorials/dft/electronic/hubbard.md
Original file line number Diff line number Diff line change
@@ -1,44 +1,91 @@
# DFT+U and Hubbard parameter calculation in Quantum Espresso

In this tutorial we demonstrate how to perform DFT+U calculation, followed by
calculation of Hubbard parameter using Quantum Espresso simulation engine on our
web platform.
calculation of Hubbard parameter using Quantum Espresso on our web platform.


### Create DFT+U workflow

First, we need to create PWscf workflow with DFT+U enabled. A PWscf calculation
(using `pw.x`) is prerequisite for Hubbard parameter (using `hp.x`) calculation.

- Navigate to workflows page from the sidebar, and create new workflow. Expand
details section and select Quantum Espresso version `7.2` from the drop-down.

![Navigation sidebar](/images/tutorials/hubbard/hubbard-01-navigation-sidebar.webp "Navigation sidebar")

![Select application version and build](/images/tutorials/hubbard/hubbard-02-select-ver-build.webp "Select application version and build")

- Click **Edit** button on the default **pw_scf** workflow unit. Expand details
pane in the unit modal, and select **pw_scf_dft_u** flavor/ template. Close the
unit modal.

![Select executable and flavor](/images/tutorials/hubbard/hubbard-03-select-executable-flavor.webp "Select executable and flavor")

!!!warning
Here we will follow the latest DFT+U syntax and method introduced in Quantum
Here we follow the latest DFT+U syntax and method introduced in Quantum
Espresso version `7.1`. The new template (syntax) **pw_scf_dft_u** is only
available to Quantum Espresso version `7.1` or above. If the user would like
to use old syntax, please select Quantum Espresso version `7.0` or below,
and use **pw_scf_dft_u_legacy**.

1. Navigate to workflow page from the sidebar, and create new workflow. Expand
details section and select Quantum Espresso version `7.2` from the drop-down.

2. Click **Edit** button on the default **pw_scf** workflow unit. Expand details
pane in the unit modal, and select **pw_scf_dft_u** flavor/ template. Close the
unit modal.
### Add hp.x unit to the workflow

Hubbard parameters can be obtained from the *first principles*. We will use
Quantum Espresso `hp.x` implementation of Linear Response theorem[^1].

We can add `hp.x` workflow to previous PWscf (DFT+U) workflow by adding a new
execution unit. Click the edit unit button on the second unit, and select `hp.x`
executable. The `q`-grid for `hp.x` can be modified in the important settings
tab.

![Add new unit](/images/tutorials/hubbard/hubbard-04-add-new-unit.webp "Add new unit")


3. Navigate to **Important Settings** tab, and scroll down to **hubbard**
### Create and submit job

- Navigate to jobs page via sidebar menu, and create new job.
- Select material, here we have selected FeO. You can import new material from
banks or upload structure files.
- Select workflow, here we select the Hubbard workflow that we just created.

![Select material and workflow](/images/tutorials/hubbard/hubbard-05-select-mat-workflow.webp "Select material and workflow")

- Navigate to **Important Settings** tab, and scroll down to **hubbard**
section. Here we are able to specify the Hubbard U values specific to atomic
species and orbital (Hubbard manifold). You can add new or delete a row in the
Hubbard card.

4. We can use this workflow to run DFT+U PWscf calculation.
![Important settings](/images/tutorials/hubbard/hubbard-06-imp-settings.webp "Important settings")

## Calculation of Hubbard parameters
![Edit Hubbard card](/images/tutorials/hubbard/hubbard-07-card-values.webp "Edit Hubbard card")

Hubbard parameters can be obtained from the *first principles*. We will use
Quantum Espresso `hp.x` implementation of Linear Response theorem[^1]. For this,
we need to add new execution unit to our workflow. Click the edit unit button,
and select `hp.x` executable. The `q`-grid for `hp.x` can be modified in the
important settings.
- Go to **Compute** tab, and select number of processors and other compute
parameters.

![Set compute parameters](/images/tutorials/hubbard/hubbard-08-compute-parameters.webp "Set compute parameters")

!!!warning
As of 20/Dec/2023, there is a bug in our platform that prevents running MPI
jobs in single processor when Intel (default) build of Quantum Espresso is
used. Please select at least 2 processors/ cores if you are using Intel
build as a workaround. Alternatively, you may use GNU build of Quantum
Espresso.

- Now we are ready to submit the job for running the calculation.

![Results](/images/tutorials/hubbard/hubbard-09-result.webp "Results")

Once the job is finished, the Hubbard U values are shown in the **Results** tab.

In the below animation, we go through an example calculation.

<div class="video-wrapper">
<iframe class="gifffer" width="100%" height="100%" src="https://www.youtube.com/embed/Uh9OWJHKlQY" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
<iframe class="gifffer" width="100%" height="100%" src="https://www.youtube.com/embed/33PykNO8QlQ" frameborder="0" allow="accelerometer; autoplay; encrypted-media; gyroscope; picture-in-picture" allowfullscreen></iframe>
</div>


## References

[^1]: [HP – A code for the calculation of Hubbard parameters using density-functional perturbation theory, I. Timrov, N. Marzari, M. Cococcioni, Computer Physics Communications, **279**, 108455 (2022)](https://doi.org/10.1016/j.cpc.2022.108455).

0 comments on commit 47f15b7

Please sign in to comment.