Skip to content
GitLab
Projects
Groups
Snippets
Help
Loading...
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Contribute to GitLab
Sign in
Toggle navigation
P
parser-elk
Project overview
Project overview
Details
Activity
Releases
Repository
Repository
Files
Commits
Branches
Tags
Contributors
Graph
Compare
Issues
1
Issues
1
List
Boards
Labels
Service Desk
Milestones
Merge Requests
0
Merge Requests
0
CI / CD
CI / CD
Pipelines
Jobs
Schedules
Operations
Operations
Incidents
Environments
Packages & Registries
Packages & Registries
Container Registry
Analytics
Analytics
CI / CD
Repository
Value Stream
Wiki
Wiki
Members
Members
Collapse sidebar
Close sidebar
Activity
Graph
Create a new issue
Jobs
Commits
Issue Boards
Open sidebar
nomad-lab
parser-elk
Commits
a4832d39
Commit
a4832d39
authored
Sep 10, 2020
by
temok-mx
Browse files
Options
Browse Files
Download
Email Patches
Plain Diff
Updated README.md; added metadata.yml; the lead branch is now master, inactive branches became tags
parent
0a43285a
Changes
3
Show whitespace changes
Inline
Side-by-side
Showing
3 changed files
with
84 additions
and
25 deletions
+84
-25
.gitlab-ci.yml
.gitlab-ci.yml
+0
-19
README.md
README.md
+77
-6
metadata.yml
metadata.yml
+7
-0
No files found.
.gitlab-ci.yml
deleted
100644 → 0
View file @
0a43285a
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 elk/test
-
export PYTHONEXE=/labEnv/bin/python
-
sbt elk/test
only
:
-
master
tags
:
-
test
-
spec2
README.md
View file @
a4832d39
[
NOMAD Laboratory CoE
](
http://nomad-coe.eu
)
parser for
[
Elk
](
http://elk.sourceforge.net/
)
This is a NOMAD parser for
[
Elk
](
http://elk.sourceforge.net/
)
. It will read Elk input and
output files and provide all information in NOMAD's unified Metainfo based Archive format.
The original repository lives at
https://gitlab.mpcdf.mpg.de/nomad-lab/parser-elk
but you probably want to checkout
https://gitlab.mpcdf.mpg.de/nomad-lab/nomad-lab-base
to also get all dependencies.
## 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.
For elk please provide at least the files from this table if applicable to your
calculations (remember that you can provide more files if you want):
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
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-elk parser-elk
pip install -e parser-elk
```
Running the parser now, will use the parser's Python code from the clone project.
metadata.yml
0 → 100644
View file @
a4832d39
code-label
:
Elk
code-label-style
:
Only E in capitals
code-url
:
http://elk.sourceforge.net/
parser-dir-name
:
dependencies/parsers/elk/
parser-git-url
:
https://gitlab.mpcdf.mpg.de/nomad-lab/parser-elk
parser-specific
:
'
'
table-of-files
:
'
'
Write
Preview
Markdown
is supported
0%
Try again
or
attach a new file
.
Attach a file
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment