Skip to content

Commit 8527b78

Browse files
committed
Refine description of collection-specific metadata
1 parent 84ace09 commit 8527b78

1 file changed

Lines changed: 13 additions & 4 deletions

File tree

README.md

Lines changed: 13 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -46,6 +46,12 @@ https://doi.org/10.1016/j.cpc.2018.01.012.
4646
julia --project=scripts scripts/add_pseudodojo.jl pseudos
4747
```
4848

49+
**Collection-specific metadata.** Contains the following element-specific metadata:
50+
* `cutoffs_normal`, `cutoffs_high`, `cutoffs_low`: Respective recommended cutoffs by PseudoDojo
51+
* `rcut`: Recommended radial cutoff when integrating numeric pseudopotentials (in Bohrs).
52+
Right now just `10.0` for each element (the QuantumEspresso hard-coded value).
53+
This may be refined in future versions of the library.
54+
4955
### [CP2K GTH-type potentials](https://github.com/cp2k/cp2k-data/tree/master/potentials/Goedecker) (prefixed cp2k)
5056

5157
```
@@ -78,6 +84,10 @@ is available in
7884
and
7985
[pseudos/cp2k.nc.sr.pbe.v0_1.md](pseudos/cp2k.nc.sr.pbe.v0_1.md).
8086

87+
**Collection-specific metadata.** Contains the following element-specific metadata:
88+
* `n_valence_electrons`: Number of valence electrons
89+
* `cp2k_filename`: The original file name used in the CP2K pseudopotential data repository.
90+
8191
## Structure of the Artifact.toml
8292
Next to the usual entries to make the `Artifact.toml` useful to download
8393
peudopotential information as a lazy artifact (using `LazyArtifacts`)
@@ -109,7 +119,9 @@ family in form of a dictionary with the following keys:
109119
* `program`: Code used to generate the pseudopotentials
110120
* `extra`: List of some extra identifiers (e.g. `semicore` or `standard`)
111121
- For each element you can add an `element.toml` file with additional metadata
112-
about this pseudopotential. Common expected fields include:
122+
about this pseudopotential. Collection-specific fields are explained
123+
above in the *Available pseudopotentials* section. Common fields
124+
available for most pseudopotential collections include:
113125
* `Ecut`: A recommended kinetic energy cutoff value for the wavefunction
114126
to be employed with this pseudopotential.
115127
Note, that some libraries set this to `-1` to indicate *unknown*.
@@ -120,9 +132,6 @@ family in form of a dictionary with the following keys:
120132
`Ecut_density = supersampling * supersampling * Ecut`, i.e. the square
121133
of the supersampling factor times the `Ecut` value above gives the
122134
density cutoff.
123-
* `n_valence_electrons`: Number of valence electrons
124-
* `rcut`: Recommended radial cutoff when integrating numeric pseudopotentials
125-
(in Bohrs)
126135

127136
Note, that for most already existing
128137
pseudopotential collections scripts have been employed to simplify the addition

0 commit comments

Comments
 (0)