scorep_metadata2json
A simple parser to convert Score-P Metadata to JSON
Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Academic email domains
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (8.8%) to scientific vocabulary
Repository
A simple parser to convert Score-P Metadata to JSON
Basic Info
- Host: GitHub
- Owner: score-p
- License: mit
- Language: Python
- Default Branch: main
- Size: 54.7 KB
Statistics
- Stars: 0
- Watchers: 5
- Forks: 0
- Open Issues: 0
- Releases: 0
Metadata Files
README.md
scorep-metadata2json
A simple parser to convert Score-P Metadata to JSON
Installation
bash
git clone https://github.com/score-p/scorep_metadata2json.git
cd scorep_metadata2json
poetry install
Usage
To use ./bin/scorep-metadata2json, activate the project's virtual environment created by poetry:
bash
./bin/scorep-metadata2json <path/to/scorep.fair>
Hint: Use data located in test/test_data for testing.
Yoy can output the schema of the parser by using the --schema option:
bash
./bin/scorep-metadata2json --schema
The schema as well as a visual representation is also available in the documentation of the basemodel.
Alternatively, if you prefer not to activate the virtual environment, you can prefix your commands with poetry run:
bash
./bin/scorep-metadata2json -h
Hint: Use jq to view the output formatted in color.
bash
./bin/scorep-metadata2json <path/to/scorep.fair> | jq
Documentation
To build the documentation, run:
bash
poetry install --with docs
poetry run sphinx-build docs docs/_build
It can then be found in docs/_build/index.html.
Development
To install the development dependencies, run:
bash
poetry install --with dev
After that, run the following commands to check the code style and type annotations:
bash
poetry run mypy .
poetry run ruff .
poetry run ruff format .
Testing
To run the tests, run:
bash
poetry run python -m unittest test/test_arg_parser.py
poetry run python -m unittest test/test_parser.py
Owner
- Name: Score-P
- Login: score-p
- Kind: organization
- Email: support@score-p.org
- Website: https://score-p.org
- Repositories: 21
- Profile: https://github.com/score-p
Read-only mirror for Score-P at https://gitlab.com/score-p/scorep. Here only complementary plug-ins and tools for the Score-P measurement infrastructure
Citation (CITATION.cff)
cff-version: 1.2.0
title: scorep-metadata2json
message: >-
If you use this software, please cite it using the
metadata from this file.
type: software
authors:
- given-names: Maximilian
family-names: Sander
email: maximilian.sander1@tu-dresden.de
affiliation: TUD Dresden University of Technology
repository-code: 'https://github.com/score-p/scorep_metadata2json'
abstract: A simple parser to convert Score-P Metadata to JSON
license: MIT
GitHub Events
Total
Last Year
Dependencies
- alabaster 0.7.16
- annotated-types 0.6.0
- autodoc-pydantic 2.0.1
- babel 2.14.0
- certifi 2023.11.17
- charset-normalizer 3.3.2
- click 8.1.7
- colorama 0.4.6
- docutils 0.20.1
- erdantic 0.6.0
- idna 3.6
- imagesize 1.4.1
- jinja2 3.1.3
- markupsafe 2.1.4
- mypy 1.8.0
- mypy-extensions 1.0.0
- packaging 23.2
- pydantic 2.6.0
- pydantic-core 2.16.1
- pydantic-settings 2.1.0
- pygments 2.17.2
- pygraphviz 1.12
- python-dotenv 1.0.1
- requests 2.31.0
- ruff 0.1.15
- snowballstemmer 2.2.0
- sphinx 7.2.6
- sphinxcontrib-applehelp 1.0.8
- sphinxcontrib-devhelp 1.0.6
- sphinxcontrib-htmlhelp 2.0.5
- sphinxcontrib-jsmath 1.0.1
- sphinxcontrib-qthelp 1.0.7
- sphinxcontrib-serializinghtml 1.1.10
- tomli 2.0.1
- typer 0.9.0
- typing-extensions 4.9.0
- urllib3 2.1.0
- mypy ^1.8.0 develop
- ruff ^0.1.15 develop
- autodoc-pydantic ^2.0.1 docs
- erdantic ^0.6.0 docs
- sphinx ^7.2.6 docs
- pydantic ^2.6.0
- python ^3.10