README.md 2.97 KB
Newer Older
1
This is a NOMAD parser for [AtomistixToolKit](https://www.synopsys.com/silicon/quantumatk.html). It will read AtomistixToolKit input and
2
output files and provide all information in NOMAD's unified Metainfo based Archive format.
Mohamed, Fawzi Roberto (fawzi)'s avatar
Mohamed, Fawzi Roberto (fawzi) committed
3

4 5 6 7 8 9 10 11 12 13 14 15
## Preparing code input and output file for uploading to NOMAD

NOMAD accepts `.zip` and `.tar.gz` archives as uploads. Each upload can contain arbitrary
files and directories. NOMAD will automatically try to choose the right parser for you files.
For each parser (i.e. for each supported code) there is one type of file that the respective
parser can recognize. We call these files `mainfiles` as they typically are the main
output file a code. For each `mainfile` that NOMAD discovers it will create an entry
in the database that users can search, view, and download. NOMAD will associate all files
in the same directory as files that also belong to 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 directly support it.

16
For AtomistixToolKit please provide at least the files from this table if applicable to your
17 18
calculations (remember that you can provide more files if you want):

19 20 21 22
|Input Filename| Description|
|--- | --- |
|`*.nc` | The NetCDF output is used as the **mainfile** (HDF5 output is currently not yet supported) |
|`*` | Other ATK input and output files act as auxiliary files that can be downloaded, put are not parsed |
23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55


To create an upload with all calculations in a directory structure:

```
zip -r <upload-file>.zip <directory>/*
```

Go to the [NOMAD upload page](https://nomad-lab.eu/prod/rae/gui/uploads) 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:
```python
import sys
from nomad.cli.parse import parse, normalize_all

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

# get the 'main section' section_run as a metainfo object
61
section_run = archive.section_run[0]
62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77

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

## Developing the parser

Also install NOMAD's pypi package:

```
pip install nomad-lab
```

Clone the parser project and install it in development mode:

```
78 79
git clone https://gitlab.mpcdf.mpg.de/nomad-lab/parser-atk parser-
pip install -e parser-
80 81 82
```

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

84 85 86 87
---
## Parser Specific
Currently, NOMAD only supports NetCDF output of AtomistixToolKit (ATK) and not the
HDF5 based output of QuantumATK.
88