Commit 76c3ef2e authored by temok-mx's avatar temok-mx
Browse files

Further update of README.md; mv metadata.yml -> metadata.yaml

parent 533c214b
......@@ -13,17 +13,8 @@ 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.
<<<<<<< HEAD
For mpes please provide at least the files from this table if applicable to your
For MPES please provide at least the files from this table if applicable to your
calculations (remember that you can provide more files if you want):
=======
## Description of files
The set of important files for the parser are explained in the following,
- [mpesparser](mpesparser): Main folder of the parser.
- [mpesparser/__init__.py](mpesparser/__init__.py): Parser module initialization code.
- [mpesparser/__main__.py](mpesparser/__main__.py): Parser module run file.
- [mpesparser/metainfo/mpes](mpesparser/metainfo/mpes.py): MPES metadata definitions.
>>>>>>> aa7fbc09aa3bde6b654b764d21cd62eaf2badc9e
......@@ -51,7 +42,6 @@ interface (CLI) and print the processing results output to stdout:
```
nomad parse --show-archive <path-to-file>
```
<<<<<<< HEAD
To parse a file in Python, you can program something like this:
```python
......@@ -59,12 +49,12 @@ import sys
from nomad.cli.parse import parse, normalize_all
# match and run the parser
backend = parse(sys.argv[1])
archive = parse(sys.argv[1])
# run all normalizers
normalize_all(backend)
normalize_all(archive)
# get the 'main section' section_run as a metainfo object
section_run = backend.resource.contents[0].section_run[0]
section_run = archive.section_run[0]
# get the same data as JSON serializable Python dict
python_dict = section_run.m_to_dict()
......@@ -76,10 +66,6 @@ Also install NOMAD's pypi package:
```
pip install nomad-lab
=======
cd nomad/dependencies/parsers/parser-mpes
python -m parser-mpes tests/mpes.meta
>>>>>>> aa7fbc09aa3bde6b654b764d21cd62eaf2badc9e
```
Clone the parser project and install it in development mode:
......@@ -90,3 +76,8 @@ pip install -e parser-mpes
```
Running the parser now, will use the parser's Python code from the clone project.
---
## Parser Specific
MPES (Multidimensional photoemission spectroscopy) is a parser for experimental data.
codeLabel: MPES
codeLabelStyle: All in capitals
codeUrl: https://mpes-kit.github.io/mpes
parserDirName: dependencies/parsers/mpes/
parserGitUrl: https://gitlab.mpcdf.mpg.de/nomad-lab/parser-mpes
parserSpecific: |
MPES (Multidimensional photoemission spectroscopy) is a parser for experimental data.
tableOfFiles: ''
code-label: MPES
code-label-style: All in capitals
code-url: https://mpes-kit.github.io/mpes
parser-dir-name: dependencies/parsers/mpes/
parser-git-url: https://gitlab.mpcdf.mpg.de/nomad-lab/parser-mpes
parser-specific: |
MPES (Multidimensional photoemission spectroscopy) is a parser for experimental data.
table-of-files: ''
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment