Skip to content

Commit

Permalink
Fixing paths to the correct tutorial folder on the github repo in the…
Browse files Browse the repository at this point in the history
… tutorials files
  • Loading branch information
Valerio authored and qiaojunfeng committed Feb 16, 2024
1 parent 669a346 commit 4a5902a
Show file tree
Hide file tree
Showing 33 changed files with 47 additions and 39 deletions.
4 changes: 2 additions & 2 deletions docs/docs/tutorials/tutorial_1.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@
pseudopotentials and a <br>
2$\times$2$\times$2 k-point grid. Starting guess: four bond-centred Gaussians.*

- Directory: `tutorials/tutorial01/` *Files can be
downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial01)*
- Directory: `tutorials/tutorial01/` *Files can be downloaded from
[here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial01)*

- Input Files

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/tutorials/tutorial_10.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

- Outline: *Obtain MLWFs for graphite (AB, Bernal)*

- Directory: `tutorials/tutorial10/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial10)*
- Directory: `tutorials/tutorial10/` *Files can be downloaded from
[here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial10)*

- Input Files

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_11.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- Outline: *Obtain MLWFs for the valence bands of silicon.*

- Directory: `tutorials/tutorial11/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial11)*
- Directory: `tutorials/tutorial11/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial11)*

- Input Files

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_12.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- Outline: *Obtain MLWFs for the valence states of benzene*

- Directory: `tutorials/tutorial12/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial12)*
- Directory: `tutorials/tutorial12/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial12)*

- Input Files

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_13.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- Outline: *Obtain the bandstructure, quantum conductance and density
of states of a metallic (5,5) carbon nanotube*

- Directory: `tutorials/tutorial13/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial13)*
- Directory: `tutorials/tutorial13/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial13)*

- Input Files

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/tutorials/tutorial_14.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,8 +4,8 @@
of Sodium atoms with that of a defected chain*

- Directories: `tutorials/tutorial14/periodic`<br>
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; `tutorial/tutorial14/defected`<br>
*Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial14)*
&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; `tutorials/tutorial14/defected`<br>
*Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial14)*

- Input Files

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/tutorials/tutorial_15.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ structure calculations.*
- Outline: *Obtain the quantum conductance of a pristine single-walled
carbon nanotube*

- Directory: `tutorials/tutorial14/periodic` *Files can be downloaded fron [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial15)*
- Directory: `tutorials/tutorial14/periodic` *Files can be downloaded fron [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial15)*

- Input Files

Expand Down Expand Up @@ -37,7 +37,7 @@ compare the quantum conductance of this system with a defected nanotube.
- Outline: *Use the automated LCR routine to investigate the effect of
a single silicon atom in a infinite (5,0) carbon nanotube.*

- Directory: `tutorial/tutorial15/defected` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial15)*
- Directory: `tutorials/tutorial15/defected` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial15)*

- Input Files

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/tutorials/tutorial_16.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

## If you want to use Quantum ESPRESSO {#if-you-want-to-use-quantum-espresso .unnumbered}

- Directory: `tutorials/tutorial16-withqe/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial16)*
- Directory: `tutorials/tutorial16-withqe/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial16)*

- Input Files

Expand All @@ -23,7 +23,7 @@

## If you do not want to use Quantum ESPRESSO {#if-you-do-not-want-to-use-quantum-espresso .unnumbered}

- Directory: `tutorial/tutorial16-noqe/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial16)*
- Directory: `tutorials/tutorial16-noqe/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial16)*

- Input Files

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_17.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ interface.
- Outline: *Plot the spin-orbit-coupled bands of ferromagnetic bcc Fe.
Plot the Fermi-surface contours on a plane in the Brillouin zone.*

- Directory: `tutorials/tutorial17/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial17)*
- Directory: `tutorials/tutorial17/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial17)*

- Input files

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_18.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ interface.
Fe with spin-orbit coupling. In preparation for this tutorial it may
be useful to read Ref. [@yao-prl04] and Ch. 11 of the User Guide.*

- Directory: `tutorials/tutorial18/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial18)*
- Directory: `tutorials/tutorial18/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial18)*

- Input files

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_19.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ interface.
- Outline: *Calculate the orbital magnetization of ferromagnetic bcc
Fe by Wannier interpolation.*

- Directory: `tutorials/tutorial19/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial19)*
- Directory: `tutorials/tutorial19/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial19)*

- Input files

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_2.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
4$\times$4$\times$4 k-point grid.
Starting guess: atom-centred sp$^3$ hybrid orbitals*

- Directory: `tutorials/tutorial02/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial02)*
- Directory: `tutorials/tutorial02/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial02)*

- Input Files

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_20.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

- Outline: *Obtain disentangled MLWFs for strained LaVO$_3$.*

- Directory: `tutorials/tutorial20/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial20)*
- Directory: `tutorials/tutorial20/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial20)*

- Input Files

Expand Down
4 changes: 2 additions & 2 deletions docs/docs/tutorials/tutorial_21.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ interface.
symmetry-adapted Wannier functions, see R. Sakuma, Phys. Rev. B
**87**, 235109 (2013).*

- Directory: `tutorials/tutorial21/atom_centered_As_sp/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial21)*
- Directory: `tutorials/tutorial21/atom_centered_As_sp/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial21)*

- Input Files

Expand Down Expand Up @@ -58,6 +58,6 @@ interface.
```

Each directory creates different kind of symmetry-adapted Wannier
function. See more detail in `tutorials/tutorial21/README`.
function. See more detail in `tree/develop/tutorials/tutorial21/README`.


2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_22.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ interface.
theoretical background of the symmetry-adapted Wannier functions,
see R. Sakuma, Phys. Rev. B **87**, 235109 (2013).*

- Directory: `tutorials/tutorial22/s_at_0.00/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial22)*
- Directory: `tutorials/tutorial22/s_at_0.00/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial22)*
\

- Input Files
Expand Down
4 changes: 2 additions & 2 deletions docs/docs/tutorials/tutorial_23.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ post-processing code of `yambo`.
`yambo` code, the quasi-particle corrections (QP) are summed to
Kohn-Sham eigenvalues, while the wavefunctions remain the same. *

- Directory: `tutorials/tutorial23/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial23)*
- Directory: `tutorials/tutorial23/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial23)*

- Input Files

Expand Down Expand Up @@ -54,7 +54,7 @@ post-processing code of `yambo`.
grid into the 8x8x8 reduced grid

```bash title="Terminal"
./k_mapper.py 4 4 4 "../tutorials/tutorial23/WORK/nscf.gw.out"
./k_mapper.py 4 4 4 "..tutorials/tutorial23/WORK/nscf.gw.out"
```

Use the output to complete the `yambo.in` input file (you also need
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_24.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
- Outline: *Calculate the gyrotropic effects in trigonal right-handed
Te* Similar to the calculations of [@tsirkin-arxiv17]

- Directory: `tutorials/tutorial24/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial24)*
- Directory: `tutorials/tutorial24/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial24)*

- Input files

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_25.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
asymmetric fcc Gallium Arsenide. In preparation for this tutorial it
may be useful to read Ref. [@ibanez-azpiroz_ab_2018]*

- Directory: `tutorials/tutorial25/` *Files can be downlowaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial25)*
- Directory: `tutorials/tutorial25/` *Files can be downlowaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial25)*

- Input files:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_26.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
Ref. [@Marianetti], which is essential reading for this tutorial
tutorial.*

- Directory: `tutorials/tutorial26/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial26)*
- Directory: `tutorials/tutorial26/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial26)*

- Input files:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_27.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ post-processing code of `Quantum ESPRESSO` (v6.4 or above).
methods explained in Ref. [@LinLin-ArXiv2017]. More info on the
keywords related to the SCDM method may be found in the user_guide.*

- Directory: `tutorials/tutorial27/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial27)*
- Directory: `tutorials/tutorial27/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial27)*

- Input Files: `input_files`, and in the three subfolders
`isolated, erfc` and `gaussian`. The `input_files` folder contains:
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_28.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
them in Gaussian cube format*

- Directory: `tutorials/tutorial28/` *The input files for this tutorials
are the same as the ones in Tutorial [5](tutorial_5.md#diamond-mlwfs-for-the-valence-bands) and can be downloaded [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial28)*
are the same as the ones in Tutorial [5](tutorial_5.md#diamond-mlwfs-for-the-valence-bands) and can be downloaded [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial28)*

- Input Files

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_29.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
the [berry_task=shc: spin Hall conductivity](../user_guide/postw90/berry.md#sec:shc)
chapter of the User Guide.*

- Directory: `tutorials/tutorial29/` *Files can be downloaded [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial29)*
- Directory: `tutorials/tutorial29/` *Files can be downloaded [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial29)*

- Input files

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_3.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@
4$\times$4$\times$4 k-point grid.
Starting guess: atom-centred sp$^3$ hybrid orbitals*

- Directory: `tutorials/tutorial03/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial03)*
- Directory: `tutorials/tutorial03/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial03)*

- Input Files

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/tutorials/tutorial_30.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,8 @@
[berry_task=shc: spin Hall conductivity](../user_guide/postw90/berry.md#sec:shc)
chapter of the User Guide.*

- Directory: `tutorials/tutorial30/`
- Directory: `tutorials/tutorial30/` *Files can downloaded from
[here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial30)*

- Input files

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/tutorials/tutorial_31.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,8 @@ post-processing code of `Quantum ESPRESSO` (v6.3 or above).
spin-noncollinear systems. For the overview of the use of SCDM
method to spinless systems, please refer to this [tutorial](tutorial_27.md).

- Directory: `tutorials/tutorial31/`
- Directory: `tutorials/tutorial31/` *Files can be downloaded from
[here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial31)*

The input files for this tutorials are similar to the ones in Tutorial
[29](tutorial_29.md#platinum-spin-hall-conductivity), except that a coarser k-point grid is used and that the keywords
Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_32.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@
can be downloaded from the MaterialsCloud
website[@MaterialsCloudArchiveEntry].

- Directory: `tutorials/tutorial32/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial32)*
- Directory: `tutorials/tutorial32/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial32)*

- Input files

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_33.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@
preparation for this example it may be useful to read Ref.
[@ibanez-azpiroz-ArXiv2019]*

- Directory: `tutorial/tutorial33/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial33)*
- Directory: `tutorial/tutorial33/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial33)*

- Input files:

Expand Down
2 changes: 1 addition & 1 deletion docs/docs/tutorials/tutorial_4.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@
Starting guess: five atom-centred d orbitals, and two s orbitals
centred on one of each of the two tetrahedral interstices.*

- Directory: `tutorials/tutorial04/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial04)*
- Directory: `tutorials/tutorial04/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial04)*

- Input Files

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/tutorials/tutorial_5.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

- Outline: *Obtain MLWFs for the valence bands of diamond*

- Directory: `tutorials/tutorial05/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial05)*
- Directory: `tutorials/tutorial05/` *Files can be downloaded from
[here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial05)*

- Input Files

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/tutorials/tutorial_6.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
- Outline: *Obtain MLWFs to describe the states around the Fermi-level
in copper*

- Directory: `tutorials/tutorial06/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial06)*
- Directory: `tutorials/tutorial06/` *Files can be downloaded from
[here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial06)*

- Input Files

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/tutorials/tutorial_7.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
- Outline: *Obtain MLWFs for the occupied states of molecular silane.
$\Gamma$-point sampling*

- Directory: `tutorials/tutorial07/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial07)*
- Directory: `tutorials/tutorial07/` *Files can be downloaded from
[here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial07)*

- Input Files

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/tutorials/tutorial_8.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,8 @@
functions for ferromagnetic bcc Fe. Calculate the total and
orbital-projected density of states by Wannier interpolation.*

- Directory: `tutorials/tutorial08/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial08)*
- Directory: `tutorials/tutorial08/` *Files can be downloaded from
[here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial08)*

- Input Files

Expand Down
3 changes: 2 additions & 1 deletion docs/docs/tutorials/tutorial_9.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,8 @@

- Outline: *Obtain MLWFs for a perovskite*

- Directory: `tutorials/tutorial09/` *Files can be downloaded from [here](https://github.com/wannier-developers/wannier90/tutorials/tutorial09)*
- Directory: `tutorials/tutorial09/` *Files can be downloaded from
[here](https://github.com/wannier-developers/wannier90/tree/develop/tutorials/tutorial09)*

- Input Files

Expand Down

0 comments on commit 4a5902a

Please sign in to comment.