openPMD Validator Scripts

This repository contains scripts to validate existing files that (claim to) implement the openPMD Standard in version 1.1.*.

Additional scripts to create random/empty files with the valid markup of the standard are also provided.

Rationale

These tools are intended for developers that want to implementent the standard. They were written to allow an easy implement-test-correct workflow without the hazzle to check every word of the written standard twice.

Nevertheless, these scripts can not validate 100% of the standard and uncovered sections shall be cross-checked manually with the words of the written standard.

For more information on requirements for implementations, please refer to the section Implementations of the openPMD standard. The repository openPMD-projects also lists a large collection of open source projects that already implement the openPMD standard.

Install

Choose one of the install methods below to get started:

PyPI

# optional: append --user
pip install openPMD-validator==1.1.0.6

Spack

spack install py-openpmd-validator@1.1.0.6 ^py-h5py~mpi
spack load --dependencies py-openpmd-validator@1.1.0.6 ^py-h5py~mpi

Conda

conda install -c conda-forge openpmd-validator

From Source

wget https://github.com/openPMD/openPMD-validator/archive/1.1.0.6.tar.gz
tar -xf 1.1.0.6.tar.gz
cd openPMD-validator-1.1.0.6/

# optional: append --user
python setup.py install

Usage

CLI

We provide the command-line tools for individual files:

# optional: create dummy example files
openPMD_createExamples_h5

# validate
openPMD_check_h5 -i example.h5
#   optional: append --EDPIC for the Partice-in-Cell Extension

Module

Additionally, the validator tools can be used as Python module in your projects, e.g. to verify a file before opening it for reading.

Create:

from openpmd_validator import createExamples_h5


# create "example.h5"
createExamples_h5.main()

Check:

from openpmd_validator import check_h5


result_array = check_h5.check_file("example.h5", verbose=False)

print("Result: %d Errors and %d Warnings."
      %( result_array[0], result_array[1]))

Development

The development of these scripts is carried out per-branch. Each branch corresponds to a certain version of the standard and might be updated in case tests did contain bugs or we found a way to cover more sections of the standard.