nomad-parser-plugins-electronic 1.1.0

⚠️ Status notice:
This repository contains parsers based on NOMAD’s legacy simulation schema.
Active development is now focused on a new schema and parser suite.
We encourage continued reporting of issues. These will be carried over and addressed within the new suite. Reported bugs will generally not be fixed here unless critical.
Please see our pinned issue for details and follow progress in the new repository: nomad-parser-plugins-simulation.

This is a collection of the NOMAD parsers for the following electronic codes:

1. ABACUS
2. ABINIT
3. AMS
4. QuantumATK
5. BigDFT
6. CASTEP
7. CHARMM
8. CP2K
9. CPMD
10. CRYSTAL
11. DMol3
12. Elk
13. exciting
14. FHI-aims
15. FLEUR
16. FPLO
17. GAMESS
18. Gaussian
19. GPAW
20. Molcas
21. Molpro
22. MOPAC
23. NWChem
24. OCEAN
25. Octopus
26. ONETEP
27. OpenMX
28. ORCA
29. Psi4
30. Qball
31. Qbox
32. QuantumESPRESSO
33. SIESTA
34. soliddmft
35. TURBOMOLE
36. VASP
37. w2dynamics
38. Wannier90
39. WIEN2k
40. YAMBO

Preparing code input and output file for uploading to NOMAD

An upload is basically a directory structure with files. If you have all the files locally you can just upload everything as a .zip or .tar.gz file in a single step. While the upload is in the staging area (i.e. before it is published) you can also easily add or remove files in the directory tree via the web interface. NOMAD will automatically try to choose the right parser for you files.

For each parser there is one type of file that the respective parser can recognize. We call these files mainfiles. For each mainfile that NOMAD discovers it will create an entry in the database, which users can search, view, and download. NOMAD will consider all files in the same directory as auxiliary files that also are associated with that entry. Parsers might also read information from these auxillary files. This way you can add more files to an entry, even if the respective parser/code might not use them. However, we strongly recommend to not have multiple mainfiles in the same directory. For CMS calculations, we recommend having a separate directory for each code run.

Go to the NOMAD upload page to upload files or find instructions about how to upload files from the command line.

Using the parser

You can use NOMAD's parsers and normalizers locally on your computer. You need to install NOMAD's pypi package:

pip install nomad-lab

To parse code input/output from the command line, you can use NOMAD's command line interface (CLI) and print the processing results output to stdout:

nomad parse --show-archive <path-to-file>

To parse a file in Python, you can program something like this:

import sys
from nomad.cli.parse import parse, normalize_all

# match and run the parser
archive = parse(sys.argv[1])
# run all normalizers
normalize_all(archive)

# get the 'main section' section_run as a metainfo object
section_run = archive.section_run[0]

# get the same data as JSON serializable Python dict
python_dict = section_run.m_to_dict()

Developing the parser

Create a virtual environment to install the parser in development mode:

pip install virtualenv
virtualenv -p `which python3` .pyenv
source .pyenv/bin/activate

Install NOMAD's pypi package:

pip install nomad-lab

Clone the parser project and install it in development mode:

git clone https://github.com/nomad-coe/electronic-parsers.git electronic-parsers
pip install -e "electronic-parsers[dev]"

Running the parser now, will use the parser's Python code from the clone project.

How to cite this work

Ladines, A.N., Chang, T., Daelman, N., Fekete, A., Frodlová, J., Ghiringhelli, L.M., Himanen, L., Ilyas, A., Nakhaee, Ondračka, P., M. Pizarro, Rudzinski, J.F., & Scheidgen, M Atomistic Parsers [Computer software]. https://doi.org/10.5281/zenodo.13880705