https://github.com/zhubonan/dojo-upf-trim
dojo-upf-trim
https://github.com/zhubonan/dojo-upf-trim
Last synced: 2 months ago
JSON representation
dojo-upf-trim
- Host: GitHub
- URL: https://github.com/zhubonan/dojo-upf-trim
- Owner: zhubonan
- Created: 2023-12-13T03:05:07.000Z (over 1 year ago)
- Default Branch: master
- Last Pushed: 2023-12-13T03:24:18.000Z (over 1 year ago)
- Last Synced: 2025-02-05T11:52:51.412Z (4 months ago)
- Language: Python
- Size: 9.74 MB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Script for trimming UPF potentials
This repository contains the script used for trimming UPF files, used in [Bosoni, E., Beal, L., Bercx, M. et al. How to verify the precision of density-functional-theory implementations via reproducible and universal workflows. Nat Rev Phys (2023)](https://www.nature.com/articles/s42254-023-00655-3). The original UPF files and trimmmed UPF files are also included for reference.
Trimming is need as Abinit discards data beyond a certain radius which is harded-coded into the code. This is because long-range data are not relavent and may contain errors. Other code may handle this differently when reading the same pseudopotential, e.g. using a different radius (QE) or use the data as provided (CASTEP).
Hence, to make all codes ending up with the same set of pseudopotential data without any code modification, we choose to trim the data in the the UPF files instead.
## Usage
A commandline interface is provided for timming ALL UFP pseudopotentials from a folder:
```
$ python upftrim.py --help
usage: upftrim [-h] [--mesh MESH] [--verbose] indir outdir
Tool for trimming UPF files down to a certain mesh size
positional arguments:
indir
outdir
optional arguments:
-h, --help show this help message and exit
--mesh MESH
--verbose
```
The only parameter needed is `--mesh` which defines the upper limit of the mesh size. Data beyond this limit are be discarded.
The value of `600` is used for the work mentioned above which corresponds to 6 bhor.