5. Pseudopotentials and basis data

RESCU needs a pseudopotential file for every element in a calculation, and NanoDCAL needs a neutral-atom basis file. LatticeMind keeps them in one library on your computer and adds the right files to each project itself. You never upload potential files into a project or write their paths into an input.

5.1. What is ready after installation

LatticeMind comes with the Nanoacademic TM PBE and Nanoacademic TM LDA sets for RESCU: Troullier-Martins potentials with SZP, DZP and DZDP atomic-orbital bases for 70 elements under LDA and 51 under PBE. latticemind setup installs them, and so does the first calculation that needs one, so RESCU calculations work straight away, with no download.

The other Nanoacademic sets come from the Nanoacademic Portal:

Set

Solver

Elements

Downloaded file starts with

PseudoDojo ONCV PBE (v0.4)

RESCU

70

psdojo_pbe. Adds PBE potentials the TM PBE set lacks, such as F, Br, I and the alkali and noble-gas elements, with SZP, DZP and TZP bases.

PseudoDojo ONCV LDA (v0.4)

RESCU

70

psdojo_lda (TZP bases).

Nanoacademic ONCV-PBE-TZP Lanthanides

RESCU

15

Nanoacademic_ONCV-PBE-TZP_Lanthanides (a .rar file).

NanoDCAL neutral-atom database

NanoDCAL

71

neutralatomdatabase. Needed to run NanoDCAL.

Nanoacademic TM PBE / TM LDA

RESCU

51 / 70

Nano_TM_PBE / Nano_TM_LDA. Already installed; the download adds each set’s accuracy tables.

5.2. Adding a set

Run:

latticemind pseudopotentials

It lists what is installed and what the portal offers, then walks you through adding a set:

  1. Open the Nanoacademic Portal pseudopotential page in a web browser and sign in to your Nanoacademic account (create one if you do not have one).

  2. Download the set you need.

  3. Leave the file in your Downloads folder, or move it to ~/.latticemind/pseudopotentials/downloads. On a remote machine, such as qBraid or a cluster, upload the file there first; any folder works.

  4. Press Enter in latticemind pseudopotentials. It finds the file, asks once, unpacks it into the library and checks it. If the file is somewhere else, type its path instead.

You can also install a file directly:

latticemind pseudopotentials install ~/Downloads/psdojo_pbe_v0.4-TM-PBE.4.tar.gz

Or say it in a conversation: “I downloaded the PseudoDojo PBE set to my Downloads folder, please install it.” LatticeMind asks your permission and then installs it.

.tar.gz, .tar and .zip files are unpacked by LatticeMind itself. A .rar file is unpacked with a tool already on the computer: the built-in tar on Windows 10 and later and on macOS, or 7z, unrar or unar on Linux. If none is available, unpack the file with any archive tool and install the unpacked folder:

latticemind pseudopotentials install ~/Downloads/release_lanthanides

Installing a set again replaces the earlier copy. To see the library at any time:

latticemind pseudopotentials status

A single RESCU file (.mat) or NanoDCAL file (.nad) installs the same way, as long as its name follows the Nanoacademic pattern — element, functional, family and basis, as in Si_PBE_TM_DZP.mat — and LatticeMind can read its header:

latticemind pseudopotentials install ~/Downloads/Fe_PBE_TM_DZP.mat

5.3. When a potential is missing or does not match

Run latticemind pseudopotentials first. It shows which sets are installed and adds the one you need; nothing else is required. In particular:

  • Copying potential files into a project folder, or attaching them with /attach, does not make a calculation use them. Install them instead.

  • Files written for other programs (UPF, PSP8, PSML, VASP POTCAR) cannot be used by RESCU or NanoDCAL. Download the Nanoacademic set from the portal.

  • A file LatticeMind cannot read, for example a truncated copy, is refused with that reason. Download its set again from the portal.

  • A different functional is never substituted silently: if fluorine is installed for LDA only, a PBE calculation of LiF waits until a PBE set that contains fluorine is installed, or until you choose LDA.

Every message LatticeMind gives about a missing or refused potential names this command and this page. There is no administrator to contact for it.

5.4. How LatticeMind chooses a potential

When it sets up a calculation, LatticeMind lists the installed files for each element of the structure. For each file it reads the exchange-correlation functional, the family (TM or ONCV), the basis, the number of valence electrons, whether spin-orbit terms and a core correction are included, and, where a set ships them, its own accuracy tables. These are the Delta value against all-electron WIEN2k and the equation of state of the elemental solid. LatticeMind chooses one consistent set for all elements, says which one it chose and why, and follows a choice you state (“use the PseudoDojo PBE potentials”).

Without a stated preference, a Nanoacademic TM file is used where one exists for the requested functional and basis. A different functional or basis is never substituted silently. If an element is missing, LatticeMind names the portal set that contains it and the steps above.

The accuracy tables describe the elemental solids the set’s authors tested. They help compare sets, but they do not show that a potential suits your material or property.

5.5. Where the files are

The library is ~/.latticemind/pseudopotentials:

~/.latticemind/pseudopotentials/
    rescu/nano_tm_pbe/          RESCU sets, one folder each
    rescu/psdojo_pbe_v0.4/
    nanodcal/neutralatomdatabase/
    downloads/                  a place to leave downloaded files
    installed.json              which sets were installed, from which file

To keep the library elsewhere, for example on a persistent volume, set LATTICEMIND_PP_PATH to that folder. An existing library you configured with LATTICEMIND_RESCU_PP_PATH (or LATTICEMIND_PSEUDO_ROOT / RESCU_PSEUDO) or LATTICEMIND_NANODCAL_DATA_PATH is still used, and is searched first.

Each project receives a copy of the files its inputs use, in its pseudopotentials/ folder, so the inputs run unchanged on this computer or a remote one. When you share a project, keep those files within the terms under which you downloaded them.

VASP POTCAR files are licensed by the VASP developers and are not handled by this library; point VASP_PP_PATH at your own POTCAR directory (Settings & configuration reference).