2.63 KB
Newer Older
1 2
This is a NOMAD parser for [Amber]( It will read Amber input and
output files and provide all information in NOMAD's unified Metainfo based Archive format.

## Preparing code input and output file for uploading to NOMAD
Berk Onat's avatar
Berk Onat committed

6 7 8 9 10 11 12 13 14
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.
Berk Onat's avatar
Berk Onat committed

For Amber please provide at least the files from this table if applicable to your
calculations (remember that you can provide more files if you want):
Berk Onat's avatar
Berk Onat committed
18 19 20

To create an upload with all calculations in a directory structure:
Berk Onat's avatar
Berk Onat committed

23 24 25
zip -r <upload-file>.zip <directory>/*
Berk Onat's avatar
Berk Onat committed

27 28
Go to the [NOMAD upload page]( to upload files
or find instructions about how to upload files from the command line.
Berk Onat's avatar
Berk Onat committed

## Using the parser
Berk Onat's avatar
Berk Onat committed

32 33
You can use NOMAD's parsers and normalizers locally on your computer. You need to install
NOMAD's pypi package:
Berk Onat's avatar
Berk Onat committed

35 36 37
pip install nomad-lab
Berk Onat's avatar
Berk Onat committed

39 40
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:
Berk Onat's avatar
Berk Onat committed

42 43 44
nomad parse --show-archive <path-to-file>

46 47 48 49 50 51
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
55 56

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

# 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:

git clone parser-amber
pip install -e parser-amber

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

## Parser Specific
The Amber parser supports the SANDER and PMEMD Molecular Dynamics codes.