https://github.com/addmorepower/nomad-sxdm_parser
A NOMAD parser for SXDM HDF5 files
Science Score: 26.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○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 (17.0%) to scientific vocabulary
Repository
A NOMAD parser for SXDM HDF5 files
Basic Info
- Host: GitHub
- Owner: AddMorePower
- License: mit
- Language: Python
- Default Branch: main
- Size: 2.33 MB
Statistics
- Stars: 1
- Watchers: 3
- Forks: 1
- Open Issues: 0
- Releases: 3
Metadata Files
README.md
nomad-SXDM_parser
A parser plugin for SXDM processed files
This nomad_ plugin was generated with Cookiecutter_ along with @nomad's cookiecutter-nomad-plugin template.
Install
You should create a virtual environment. You will need the nomad-lab package (and pytest).
We recommend using Python 3.9.
sh
python3 -m venv .pyenv
source .pyenv/bin/activate
pip install --upgrade pip
pip install -e '.[dev]' --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple
Note!
Until we have an official pypi NOMAD release with the plugins functionality. Make
sure to include NOMAD's internal package registry (e.g. via --index-url).
Testing
You can run automated tests with pytest:
sh
pytest -svx tests
Run linting
sh
ruff check .
Run auto-formatting
This is entirely optional. To add this as a check in github actions pipeline, uncomment the ruff-formatting step in ./github/workflows/actions.yaml.
sh
ruff format .
Developing a NOMAD plugin
Follow the guide on how to develop NOMAD plugins.
Build the python package
The pyproject.toml file contains everything that is necessary to turn the project
into a pip installable python package. Run the python build tool to create a package distribution:
pip install build
python -m build --sdist
You can install the package with pip:
pip install dist/nomad-SXDM_parser-0.1.0
Read more about python packages, pyproject.toml, and how to upload packages to PyPI
on the PyPI documentation.
Documentation on Github pages
To deploy documentation on Github pages, make sure to enable GitHub pages via the repo settings.
To view the documentation locally, install the documentation related packages using:
sh
pip install -r requirements_docs.txt
Run the documentation server:
sh
mkdocs serve
Template update
We use cruft to update the project based on template changes. A cruft-update.yml is included in Github workflows to automatically check for updates and create pull requests to apply updates. Follow the instructions on how to enable Github Actions to create pull requests.
To run the check for updates locally, follow the instructions on cruft website.
License
Distributed under the terms of the MIT_ license, "nomad-SXDM_parser" is free and open source software
Owner
- Name: AddMorePower
- Login: AddMorePower
- Kind: organization
- Location: Germany
- Website: https://addmorepower.eu/
- Repositories: 1
- Profile: https://github.com/AddMorePower
GitHub Events
Total
- Release event: 4
- Delete event: 43
- Push event: 24
- Pull request event: 1
- Create event: 52
Last Year
- Release event: 4
- Delete event: 43
- Push event: 24
- Pull request event: 1
- Create event: 52
Dependencies
- actions/checkout v4 composite
- actions/setup-python v5 composite
- chartboost/ruff-action v1 composite
- actions/checkout v3 composite
- actions/setup-python v4 composite
- peter-evans/create-pull-request v4 composite
- actions/checkout v4 composite
- mhausenblas/mkdocs-deploy-gh-pages master composite
- nomad-lab >=1.3.0
- mkdocs *
- mkdocs-click *
- mkdocs-material ==8.1.1
- pymdown-extensions *
- 106 dependencies