# dalcorso/pslibrary architecture

> Architecture diagram of the GitHub repository dalcorso/pslibrary, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-03). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/dalcorso/pslibrary
- Repository: https://github.com/dalcorso/pslibrary

## Overview

pslibrary is a collection of atomic-code inputs and shell scripts for generating and testing Quantum ESPRESSO pseudopotentials. Users configure the QE installation path, run a generation script globally or within a functional directory, and obtain UPF files; testing is a separate workflow. The library documents PAW and ultrasoft sets, functional and relativistic variants, high- and low-cutoff sets, and lanthanide inputs. Relationships below are limited to those stated in the README; source excerpts were not provided.

Main entry points: [`make_all_ps`](https://github.com/dalcorso/pslibrary/blob/master/make_all_ps) (Generate all), [`make_ps`](https://github.com/dalcorso/pslibrary/blob/master/make_ps) (Generate functional), [`make_all_test`](https://github.com/dalcorso/pslibrary/blob/master/make_all_test) (Test all), [`make_test`](https://github.com/dalcorso/pslibrary/blob/master/make_test) (Test functional)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_setup["Configuration"]
  node_qe_path["QE path"]
end

subgraph group_generation["Generation inputs"]
  node_make_all_ps["Generate all"]
  node_make_ps["Generate functional"]
  node_functionals["Functional inputs"]
  node_paw_jobs["PAW inputs"]
  node_us_jobs["Ultrasoft inputs"]
  node_high_low["Cutoff variants<br/>[paw_ps_high.job]"]
  node_rel_jobs["Relativistic inputs"]
  node_lan_jobs["Lanthanide inputs"]
  node_upf["Generated UPFs"]
end

subgraph group_testing["Testing"]
  node_make_all_test["Test all"]
  node_make_test["Test functional"]
  node_paw_tests["PAW tests"]
  node_us_tests["Ultrasoft tests"]
end

node_user(("User"))
node_qe["QE ld1.x"]

node_user -->|"configures"| node_qe_path
node_user -->|"runs"| node_make_all_ps
node_user -->|"runs"| node_make_ps
node_make_all_ps -->|"creates UPFs"| node_upf
node_make_ps -->|"creates UPFs"| node_upf
node_paw_jobs -->|"provides inputs"| node_qe
node_us_jobs -->|"provides inputs"| node_qe
node_user -->|"runs tests"| node_make_all_test
node_user -->|"runs tests"| node_make_test
node_make_all_test -->|"tests"| node_upf
node_make_test -->|"tests"| node_upf
node_paw_tests -->|"test inputs"| node_qe
node_us_tests -->|"test inputs"| node_qe

click node_qe_path "https://github.com/dalcorso/pslibrary/blob/master/QE_path"
click node_make_all_ps "https://github.com/dalcorso/pslibrary/blob/master/make_all_ps"
click node_make_ps "https://github.com/dalcorso/pslibrary/blob/master/make_ps"
click node_functionals "https://github.com/dalcorso/pslibrary/tree/master/pbe"
click node_paw_jobs "https://github.com/dalcorso/pslibrary/blob/master/paw_ps_collection.job"
click node_us_jobs "https://github.com/dalcorso/pslibrary/blob/master/us_ps_collection.job"
click node_high_low "https://github.com/dalcorso/pslibrary/blob/master/paw_ps_high.job"
click node_rel_jobs "https://github.com/dalcorso/pslibrary/tree/master/rel-pbe"
click node_lan_jobs "https://github.com/dalcorso/pslibrary/blob/master/paw_lan_collection.job"
click node_make_all_test "https://github.com/dalcorso/pslibrary/blob/master/make_all_test"
click node_make_test "https://github.com/dalcorso/pslibrary/blob/master/make_test"
click node_paw_tests "https://github.com/dalcorso/pslibrary/blob/master/paw_ps_test_high.job"
click node_us_tests "https://github.com/dalcorso/pslibrary/blob/master/us_ps_test_high.job"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_qe_path,node_user toneBlue
class node_make_all_ps,node_make_ps,node_functionals,node_paw_jobs,node_us_jobs,node_high_low,node_rel_jobs,node_lan_jobs,node_upf toneAmber
class node_make_all_test,node_make_test,node_paw_tests,node_us_tests toneMint
class node_qe toneIndigo
```

## Components

### Configuration

- [QE path](https://github.com/dalcorso/pslibrary/blob/master/QE_path): `QE_path`

### Generation inputs

- [Generate all](https://github.com/dalcorso/pslibrary/blob/master/make_all_ps): `make_all_ps`
- [Generate functional](https://github.com/dalcorso/pslibrary/blob/master/make_ps): `make_ps`
- [Functional inputs](https://github.com/dalcorso/pslibrary/tree/master/pbe): `pbe`
- [PAW inputs](https://github.com/dalcorso/pslibrary/blob/master/paw_ps_collection.job): `paw_ps_collection.job`
- [Ultrasoft inputs](https://github.com/dalcorso/pslibrary/blob/master/us_ps_collection.job): `us_ps_collection.job`
- [Cutoff variants](https://github.com/dalcorso/pslibrary/blob/master/paw_ps_high.job): `paw_ps_high.job`
- [Relativistic inputs](https://github.com/dalcorso/pslibrary/tree/master/rel-pbe): `rel-pbe`
- [Lanthanide inputs](https://github.com/dalcorso/pslibrary/blob/master/paw_lan_collection.job): `paw_lan_collection.job`
- **Generated UPFs**

### Testing

- [Test all](https://github.com/dalcorso/pslibrary/blob/master/make_all_test): `make_all_test`
- [Test functional](https://github.com/dalcorso/pslibrary/blob/master/make_test): `make_test`
- [PAW tests](https://github.com/dalcorso/pslibrary/blob/master/paw_ps_test_high.job): `paw_ps_test_high.job`
- [Ultrasoft tests](https://github.com/dalcorso/pslibrary/blob/master/us_ps_test_high.job): `us_ps_test_high.job`

### Other components

- **User**
- **QE ld1.x**

## Connections

- User → QE path: configures (evidence: `README.md`)
- User → Generate all: runs (evidence: `README.md`)
- User → Generate functional: runs (evidence: `README.md`)
- Generate all → Generated UPFs: creates UPFs (evidence: `README.md`)
- Generate functional → Generated UPFs: creates UPFs (evidence: `README.md`)
- PAW inputs → QE ld1.x: provides inputs (evidence: `README.md`)
- Ultrasoft inputs → QE ld1.x: provides inputs (evidence: `README.md`)
- User → Test all: runs tests (evidence: `README.md`)
- User → Test functional: runs tests (evidence: `README.md`)
- Test all → Generated UPFs: tests (evidence: `README.md`)
- Test functional → Generated UPFs: tests (evidence: `README.md`)
- PAW tests → QE ld1.x: test inputs (evidence: `README.md`)
- Ultrasoft tests → QE ld1.x: test inputs (evidence: `README.md`)
