A NOMAD plugin for FAIR schemas for simulation data.
Project description
nomad-simulations
schema plugin
This is a plugin for NOMAD which contains the base sections schema definitions for materials science simulations.
Getting started
nomad-simulations
can be installed as a PyPI package using pip
. We require features from the nomad-lab
package which are not publicly available in PyPI, so an extra flag --index-url
needs to be specified when pip installing this package:
pip install nomad-simulations --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple
Development
If you want to develop locally this package, clone the project and in the workspace folder, create a virtual environment (note this project uses Python 3.9):
git clone https://github.com/nomad-coe/nomad-simulations.git
cd nomad-simulations
python3.9 -m venv .pyenv
. .pyenv/bin/activate
Make sure to have pip
upgraded:
pip install --upgrade pip
We recommend installing uv
for fast pip installation of the packages:
pip install uv
Install the nomad-lab
package:
uv pip install '.[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 (via --index-url
in the above command).
The plugin is still under development. If you would like to contribute, install the package in editable mode (with the added -e
flag) with the development dependencies:
uv pip install -e '.[dev]' --index-url https://gitlab.mpcdf.mpg.de/api/v4/projects/2187/packages/pypi/simple
Run the tests
You can run local tests using the pytest
package:
python -m pytest -sv tests
where the -s
and -v
options toggle the output verbosity.
Our CI/CD pipeline produces a more comprehensive test report using coverage
and coveralls
packages. We suggest you to generate your own coverage reports locally by doing:
uv pip install pytest-cov
python -m pytest --cov=src tests
You can also run the script to generate a local file coverage.txt
with the same information by doing:
./scripts/generate_coverage_txt.sh
Setting up plugin on your local installation
Read the NOMAD plugin documentation for all details on how to deploy the plugin on your NOMAD instance.
Run linting and auto-formatting
ruff check .
ruff format . --check
Ruff auto-formatting is also a part of the GitHub workflow actions. Make sure that before you make a Pull Request, ruff format . --check
runs in your local without any errors otherwise the workflow action will fail.
Debugging
For interactive debugging of the tests, use pytest
with the --pdb
flag.
We recommend using an IDE for debugging, e.g., VSCode.
If using VSCode, you can add the following snippet to your .vscode/launch.json
:
{
"configurations": [
{
"name": "<descriptive tag>",
"type": "debugpy",
"request": "launch",
"cwd": "${workspaceFolder}",
"program": "${workspaceFolder}/.pyenv/bin/pytest",
"justMyCode": true,
"env": {
"_PYTEST_RAISE": "1"
},
"args": [
"-sv",
"--pdb",
"<path to plugin tests>",
]
}
]
}
where ${workspaceFolder}
refers to the NOMAD root.
The settings configuration file .vscode/settings.json
performs automatically applies the linting upon saving the file progress.
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:
uv pip install -r requirements_docs.txt
Run the documentation server:
mkdocs serve
Main contributors
Name | Topics | Github profiles | |
---|---|---|---|
Dr. Nathan Daelman | nathan.daelman@physik.hu-berlin.de | DFT, Precision | @ndaelman-hu |
Dr. Bernadette Mohr | mohrbern@physik.hu-berlin.de | MD, FF | @Bernadette-Mohr |
Dr. José M. Pizarro | jose.pizarro@physik.hu-berlin.de | GW, DMFT, BSE | @JosePizarro3 |
Dr. Joseph F. Rudzinski (Coordinator) | joseph.rudzinski@physik.hu-berlin.de | General | @JFRudzinski |
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for nomad_simulations-0.0.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8dcfbe78921d75a0d6c24ffaf214f8a6f0fb0ec0ba37a1206f267467462076a |
|
MD5 | c14c5558b88de3709a754e2566361ac9 |
|
BLAKE2b-256 | 86ee6c01e4f2552596d0546b1034b33c6bcc0176e2896dafb39147e9737e2b24 |