Data

Tools

Indexes

Applications

Experiments

Open Source Science

https://github.com/openpmd/openpmd-validator

:ballot_box_with_check: Validator and Example Scripts

https://github.com/openpmd/openpmd-validator

Science Score: 36.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
  • ✓
    Committers with academic emails
    1 of 6 committers (16.7%) from academic institutions
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (13.9%) to scientific vocabulary

Keywords

community fileformat openpmd openscience research validation

Keywords from Contributors

particles
Last synced: 6 months ago · JSON representation

Repository

:ballot_box_with_check: Validator and Example Scripts

Basic Info
  • Host: GitHub
  • Owner: openPMD
  • License: isc
  • Language: Python
  • Default Branch: 1.1.X
  • Homepage:
  • Size: 313 KB
Statistics
  • Stars: 6
  • Watchers: 5
  • Forks: 8
  • Open Issues: 7
  • Releases: 0
Topics
community fileformat openpmd openscience research validation
Created over 10 years ago · Last pushed about 1 year ago
Metadata Files
Readme License

README.md

openPMD Validator Scripts

Supported Python Versions License

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

pypi version Spack Package Conda Package

Choose one of the install methods below to get started:

PyPI

```bash

optional: append --user

pip install openPMD-validator==1.1.0.6 ```

Spack

bash 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

bash conda install -c conda-forge openpmd-validator

From Source

```bash 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:

```bash

optional: create dummy example files

openPMDcreateExamplesh5

validate

openPMDcheckh5 -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: ```python from openpmdvalidator import createExamplesh5

create "example.h5"

createExamples_h5.main() ```

Check: ```python from openpmdvalidator import checkh5

resultarray = checkh5.check_file("example.h5", verbose=False)

print("Result: %d Errors and %d Warnings." %( resultarray[0], resultarray[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.

Owner

  • Name: openPMD
  • Login: openPMD
  • Kind: organization
  • Email: axelhuebl@lbl.gov

Open Standard for Particle-Mesh Data

GitHub Events

Total
  • Watch event: 2
  • Issue comment event: 1
  • Push event: 1
Last Year
  • Watch event: 2
  • Issue comment event: 1
  • Push event: 1

Committers

Last synced: over 1 year ago

All Time
  • Total Commits: 151
  • Total Committers: 6
  • Avg Commits per committer: 25.167
  • Development Distribution Score (DDS): 0.523
Past Year
  • Commits: 6
  • Committers: 1
  • Avg Commits per committer: 6.0
  • Development Distribution Score (DDS): 0.0
Top Committers
Name Email Commits
Axel Huebl a****l@p****a 72
Axel Huebl a****l@w****e 36
Remi Lehe r****e@n****g 23
Flamefire g****t@g****e 7
Remi Lehe r****e@l****v 7
Alexander Sosedkin m****k@u****o 6
Committer Domains (Top 20 + Academic)
unboiled.info: 1 lbl.gov: 1 grundis.de: 1 normalesup.org: 1 plasma.ninja: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 15
  • Total pull requests: 63
  • Average time to close issues: 3 months
  • Average time to close pull requests: 28 days
  • Total issue authors: 5
  • Total pull request authors: 6
  • Average comments per issue: 1.67
  • Average comments per pull request: 1.17
  • Merged pull requests: 60
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 0
  • Pull requests: 2
  • Average time to close issues: N/A
  • Average time to close pull requests: 2 minutes
  • Issue authors: 0
  • Pull request authors: 1
  • Average comments per issue: 0
  • Average comments per pull request: 0.0
  • Merged pull requests: 2
  • Bot issues: 0
  • Bot pull requests: 0
View more stats
Top Authors
Issue Authors
  • ax3l (10)
  • Flamefire (2)
  • PrometheusPi (2)
  • agolovanov (1)
  • RemiLehe (1)
Pull Request Authors
  • ax3l (55)
  • RemiLehe (6)
  • t184256 (2)
  • michaelsippel (1)
  • Flamefire (1)
  • PrometheusPi (1)
Top Labels
Issue Labels
enhancement (8) validator (6) bug (4) example creation (3) install & packaging (2) question (2)
Pull Request Labels
validator (28) bug (23) enhancement (17) example creation (12) install & packaging (8) format: h5 (5) format: bp (1)

Packages

  • Total packages: 1
  • Total downloads:
    • pypi 4,921 last-month
  • Total dependent packages: 0
  • Total dependent repositories: 1
  • Total versions: 8
  • Total maintainers: 2
pypi.org: openpmd-validator

Validator and examples for openPMD format

  • Versions: 8
  • Dependent Packages: 0
  • Dependent Repositories: 1
  • Downloads: 4,921 Last month
Rankings
Dependent packages count: 7.3%
Downloads: 9.3%
Forks count: 12.0%
Average: 14.8%
Dependent repos count: 22.1%
Stargazers count: 23.2%
Maintainers (2)
ax3l rlehe
Last synced: 6 months ago

Dependencies

requirements.txt pypi
  • h5py >=2.0.0
  • numpy >=1.6.1
  • python-dateutil >=2.3.0
.github/workflows/macos.yml actions
  • actions/checkout v2 composite
.github/workflows/ubuntu.yml actions
  • actions/checkout v2 composite
.github/workflows/windows.yml actions
  • actions/checkout v2 composite
setup.py pypi