Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
P
parser-tinker
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Wiki
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Snippets
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Model registry
Operate
Environments
Monitor
Incidents
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
This is an archived project. Repository and other project resources are read-only.
Show more breadcrumbs
nomad-lab
parser-tinker
Commits
8a2cfdb2
Commit
8a2cfdb2
authored
4 years ago
by
temok-mx
Browse files
Options
Downloads
Patches
Plain Diff
Updated README.md; added metadata.yml; the lead branch is now master, inactive branches became tags
parent
7f5fc6a3
No related branches found
No related tags found
No related merge requests found
Changes
3
Hide whitespace changes
Inline
Side-by-side
Showing
3 changed files
.gitlab-ci.yml
+0
-17
0 additions, 17 deletions
.gitlab-ci.yml
README.md
+65
-22
65 additions, 22 deletions
README.md
metadata.yml
+7
-0
7 additions, 0 deletions
metadata.yml
with
72 additions
and
39 deletions
.gitlab-ci.yml
deleted
100644 → 0
+
0
−
17
View file @
7f5fc6a3
stages
:
-
test
testing
:
stage
:
test
script
:
-
cd .. && rm -rf nomad-lab-base
-
git clone --recursive git@gitlab.mpcdf.mpg.de:nomad-lab/nomad-lab-base.git
-
cd nomad-lab-base
-
git submodule foreach git checkout master
-
git submodule foreach git pull
-
sbt tinker/full:test
only
:
-
master
tags
:
-
test
-
spec2
This diff is collapsed.
Click to expand it.
README.md
+
65
−
22
View file @
8a2cfdb2
# Tinker Parser
This is a NOMAD parser for
[
Tinker
](
https://dasher.wustl.edu/tinker/
)
. It will read Tinker input and
[
NOMAD Laboratory CoE
](
http://nomad-coe.eu
)
parser for
[
TINKER
](
https://dasher.wustl.edu/tinker/
)
output files and provide all information in NOMAD's unified Metainfo based Archive format.
## Version 0.0.3
This is the parser for Tinker in
[
TINKER
](
https://dasher.wustl.edu/tinker/
)
.
## Preparing code input and output file for uploading to NOMAD
The official version lives at:
git@gitlab.mpcdf.mpg.de:nomad-lab/parser-tinker.git
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.
You can browse it at:
For tinker please provide at least the files from this table if applicable to your
calculations (remember that you can provide more files if you want):
https://gitlab.rzg.mpg.de/nomad-lab/parser-tinker
It relies on having the nomad-meta-info and the python-common repositories one level higher.
The simplest way to have this is to check out nomad-lab-base recursively:
git clone --recursive git@gitlab.mpcdf.mpg.de:nomad-lab/nomad-lab-base.git
To create an upload with all calculations in a directory structure:
This parser will be in the directory parsers/tinker of this repository.
```
zip -r <upload-file>.zip <directory>/*
```
## Running and Testing the Parser
Go to the
[
NOMAD upload page
](
https://nomad-lab.eu/prod/rae/gui/uploads
)
to upload files
### Requirements
or find instructions about how to upload files from the command line.
The required python packages can be installed with (see
[
python-common
](
https://gitlab.rzg.mpg.de/nomad-lab/python-common
)
):
pip install -r nomad-lab-base/python-common/requirements.txt
## Using the parser
### Usage
You can use NOMAD's parsers and normalizers locally on your computer. You need to install
Tinker MD log output files can be parsed with
:
NOMAD's pypi package
:
python TINKERParser.py [path/toFile]
```
pip install nomad-lab
```
### Test Files
To parse code input/output from the command line, you can use NOMAD's command line
Example log output files of Tinker can be found in the directory test/examples.
interface (CLI) and print the processing results output to stdout:
More details about the calculations and files are explained in README file of test/examples.
```
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
backend
=
parse
(
sys
.
argv
[
1
])
# run all normalizers
normalize_all
(
backend
)
# get the 'main section' section_run as a metainfo object
section_run
=
backend
.
resource
.
contents
[
0
].
section_run
[
0
]
# 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 https://gitlab.mpcdf.mpg.de/nomad-lab/parser-tinker parser-tinker
pip install -e parser-tinker
```
Running the parser now, will use the parser's Python code from the clone project.
This diff is collapsed.
Click to expand it.
metadata.yml
0 → 100644
+
7
−
0
View file @
8a2cfdb2
code-label
:
Tinker
code-label-style
:
'
Capitals:
T'
code-url
:
https://dasher.wustl.edu/tinker/
parser-dir-name
:
dependencies/parsers/tinker/
parser-git-url
:
https://gitlab.mpcdf.mpg.de/nomad-lab/parser-tinker
parser-specific
:
'
'
table-of-files
:
'
'
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment