{"id":19226043,"url":"https://github.com/openpmd/openpmd-validator","last_synced_at":"2025-10-24T07:51:30.722Z","repository":{"id":2198361,"uuid":"41734949","full_name":"openPMD/openPMD-validator","owner":"openPMD","description":":ballot_box_with_check: Validator and Example Scripts","archived":false,"fork":false,"pushed_at":"2025-01-02T23:33:41.000Z","size":321,"stargazers_count":6,"open_issues_count":7,"forks_count":8,"subscribers_count":5,"default_branch":"1.1.X","last_synced_at":"2025-09-08T21:53:25.677Z","etag":null,"topics":["community","fileformat","openpmd","openscience","research","validation"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"isc","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/openPMD.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE.txt","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2015-09-01T11:38:00.000Z","updated_at":"2025-08-28T15:02:13.000Z","dependencies_parsed_at":"2025-04-21T12:47:11.743Z","dependency_job_id":null,"html_url":"https://github.com/openPMD/openPMD-validator","commit_stats":{"total_commits":140,"total_committers":6,"mean_commits":"23.333333333333332","dds":0.5642857142857143,"last_synced_commit":"f7a48791f2153783a48ab79db991115c87abcd59"},"previous_names":[],"tags_count":8,"template":false,"template_full_name":null,"purl":"pkg:github/openPMD/openPMD-validator","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openPMD%2FopenPMD-validator","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openPMD%2FopenPMD-validator/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openPMD%2FopenPMD-validator/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openPMD%2FopenPMD-validator/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/openPMD","download_url":"https://codeload.github.com/openPMD/openPMD-validator/tar.gz/refs/heads/1.1.X","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/openPMD%2FopenPMD-validator/sbom","scorecard":{"id":708677,"data":{"date":"2025-08-11","repo":{"name":"github.com/openPMD/openPMD-validator","commit":"3988dbfbedb55614683c5cb2f86ce36117812708"},"scorecard":{"version":"v5.2.1-40-gf6ed084d","commit":"f6ed084d17c9236477efd66e5b258b9d4cc7b389"},"score":3.2,"checks":[{"name":"Dangerous-Workflow","score":10,"reason":"no dangerous workflow patterns detected","details":null,"documentation":{"short":"Determines if the project's GitHub Action workflows avoid dangerous patterns.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#dangerous-workflow"}},{"name":"Binary-Artifacts","score":10,"reason":"no binaries found in the repo","details":null,"documentation":{"short":"Determines if the project has generated executable (binary) artifacts in the source repository.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#binary-artifacts"}},{"name":"Maintained","score":0,"reason":"0 commit(s) and 0 issue activity found in the last 90 days -- score normalized to 0","details":null,"documentation":{"short":"Determines if the project is \"actively maintained\".","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#maintained"}},{"name":"Code-Review","score":1,"reason":"Found 2/19 approved changesets -- score normalized to 1","details":null,"documentation":{"short":"Determines if the project requires human code review before pull requests (aka merge requests) are merged.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#code-review"}},{"name":"Packaging","score":-1,"reason":"packaging workflow not detected","details":["Warn: no GitHub/GitLab publishing workflow detected."],"documentation":{"short":"Determines if the project is published as a package that others can easily download, install, easily update, and uninstall.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#packaging"}},{"name":"Pinned-Dependencies","score":0,"reason":"dependency not pinned by hash detected -- score normalized to 0","details":["Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/macos.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/openPMD/openPMD-validator/macos.yml/1.1.X?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/ubuntu.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/openPMD/openPMD-validator/ubuntu.yml/1.1.X?enable=pin","Warn: GitHub-owned GitHubAction not pinned by hash: .github/workflows/windows.yml:15: update your workflow using https://app.stepsecurity.io/secureworkflow/openPMD/openPMD-validator/windows.yml/1.1.X?enable=pin","Warn: pipCommand not pinned by hash: .github/workflows/macos.yml:22","Warn: pipCommand not pinned by hash: .github/workflows/macos.yml:23","Warn: pipCommand not pinned by hash: .github/workflows/macos.yml:31","Warn: pipCommand not pinned by hash: .github/workflows/ubuntu.yml:19","Warn: pipCommand not pinned by hash: .github/workflows/ubuntu.yml:20","Warn: pipCommand not pinned by hash: .github/workflows/ubuntu.yml:26","Info:   0 out of   3 GitHub-owned GitHubAction dependencies pinned","Info:   0 out of   6 pipCommand dependencies pinned"],"documentation":{"short":"Determines if the project has declared and pinned the dependencies of its build process.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#pinned-dependencies"}},{"name":"Token-Permissions","score":0,"reason":"detected GitHub workflow tokens with excessive permissions","details":["Warn: no topLevel permission defined: .github/workflows/macos.yml:1","Warn: no topLevel permission defined: .github/workflows/ubuntu.yml:1","Warn: no topLevel permission defined: .github/workflows/windows.yml:1","Info: no jobLevel write permissions found"],"documentation":{"short":"Determines if the project's workflows follow the principle of least privilege.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#token-permissions"}},{"name":"CII-Best-Practices","score":0,"reason":"no effort to earn an OpenSSF best practices badge detected","details":null,"documentation":{"short":"Determines if the project has an OpenSSF (formerly CII) Best Practices Badge.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#cii-best-practices"}},{"name":"Fuzzing","score":0,"reason":"project is not fuzzed","details":["Warn: no fuzzer integrations found"],"documentation":{"short":"Determines if the project uses fuzzing.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#fuzzing"}},{"name":"License","score":10,"reason":"license file detected","details":["Info: project has a license file: LICENSE.txt:0","Info: FSF or OSI recognized license: ISC License: LICENSE.txt:0"],"documentation":{"short":"Determines if the project has defined a license.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#license"}},{"name":"Branch-Protection","score":-1,"reason":"internal error: error during branchesHandler.setup: internal error: githubv4.Query: Resource not accessible by integration","details":null,"documentation":{"short":"Determines if the default and release branches are protected with GitHub's branch protection settings.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#branch-protection"}},{"name":"Security-Policy","score":0,"reason":"security policy file not detected","details":["Warn: no security policy file detected","Warn: no security file to analyze","Warn: no security file to analyze","Warn: no security file to analyze"],"documentation":{"short":"Determines if the project has published a security policy.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#security-policy"}},{"name":"Signed-Releases","score":-1,"reason":"no releases found","details":null,"documentation":{"short":"Determines if the project cryptographically signs release artifacts.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#signed-releases"}},{"name":"Vulnerabilities","score":3,"reason":"7 existing vulnerabilities detected","details":["Warn: Project is vulnerable to: PYSEC-2018-34 / GHSA-2fc2-6r4j-p65h","Warn: Project is vulnerable to: PYSEC-2021-856 / GHSA-5545-2q6w-2gh6","Warn: Project is vulnerable to: PYSEC-2019-108 / GHSA-9fq2-x9r6-wfmf","Warn: Project is vulnerable to: PYSEC-2018-33 / GHSA-cw6w-4rcx-xphc","Warn: Project is vulnerable to: PYSEC-2021-857 / GHSA-f7c7-j99h-c22f","Warn: Project is vulnerable to: GHSA-fpfv-jqm9-f5jm","Warn: Project is vulnerable to: PYSEC-2017-1 / GHSA-frgw-fgh6-9g52"],"documentation":{"short":"Determines if the project has open, known unfixed vulnerabilities.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#vulnerabilities"}},{"name":"SAST","score":0,"reason":"SAST tool is not run on all commits -- score normalized to 0","details":["Warn: 0 commits out of 20 are checked with a SAST tool"],"documentation":{"short":"Determines if the project uses static code analysis.","url":"https://github.com/ossf/scorecard/blob/f6ed084d17c9236477efd66e5b258b9d4cc7b389/docs/checks.md#sast"}}]},"last_synced_at":"2025-08-22T07:30:24.191Z","repository_id":2198361,"created_at":"2025-08-22T07:30:24.191Z","updated_at":"2025-08-22T07:30:24.191Z"},"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":280761857,"owners_count":26386245,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","status":"online","status_checked_at":"2025-10-24T02:00:06.418Z","response_time":73,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["community","fileformat","openpmd","openscience","research","validation"],"created_at":"2024-11-09T15:17:10.262Z","updated_at":"2025-10-24T07:51:30.662Z","avatar_url":"https://github.com/openPMD.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# openPMD Validator Scripts\n\n![Supported Python Versions](https://img.shields.io/pypi/pyversions/openPMD-validator.svg)\n[![License](https://img.shields.io/badge/license-ISC-blue.svg)](https://opensource.org/licenses/ISC)\n\nThis repository contains scripts to validate existing files that (claim to)\nimplement the [openPMD Standard](https://github.com/openPMD/openPMD-standard)\nin version `1.1.*`.\n\nAdditional scripts to create random/empty files with the valid markup of the\nstandard are also provided.\n\n\n## Rationale\n\nThese tools are intended for developers that want to implementent the standard.\nThey were written to allow an easy *implement-test-correct* workflow without\nthe hazzle to check every word of the written standard twice.\n\nNevertheless, these scripts can not validate 100% of the standard and uncovered\nsections shall be cross-checked manually with the words of the written\nstandard.\n\nFor more information on requirements for implementations, please refer to the\nsection\n[*Implementations*](https://github.com/openPMD/openPMD-standard/blob/1.1.0/STANDARD.md#implementations)\nof the openPMD standard. The repository\n  [openPMD-projects](https://github.com/openPMD/openPMD-projects)\nalso lists a large collection of open source projects that already implement\nthe openPMD standard.\n\n\n## Install\n\n[![pypi version](https://img.shields.io/pypi/v/openPMD-validator.svg)](https://pypi.python.org/pypi/openPMD-validator)\n[![Spack Package](https://img.shields.io/badge/spack-py--openpmd--validator-blue.svg)](https://spack.io)\n[![Conda Package](https://img.shields.io/badge/conda.io-openpmd--validator-brightgreen)](https://anaconda.org/conda-forge/openpmd-validator)\n\n\nChoose *one* of the install methods below to get started:\n\n### PyPI\n\n```bash\n# optional: append --user\npip install openPMD-validator==1.1.0.6\n```\n\n### Spack\n\n```bash\nspack install py-openpmd-validator@1.1.0.6 ^py-h5py~mpi\nspack load --dependencies py-openpmd-validator@1.1.0.6 ^py-h5py~mpi\n```\n\n### Conda\n\n```bash\nconda install -c conda-forge openpmd-validator\n```\n\n### From Source\n\n```bash\nwget https://github.com/openPMD/openPMD-validator/archive/1.1.0.6.tar.gz\ntar -xf 1.1.0.6.tar.gz\ncd openPMD-validator-1.1.0.6/\n\n# optional: append --user\npython setup.py install\n```\n\n## Usage\n\n### CLI\n\nWe provide the command-line tools for individual files:\n\n```bash\n# optional: create dummy example files\nopenPMD_createExamples_h5\n\n# validate\nopenPMD_check_h5 -i example.h5\n#   optional: append --EDPIC for the Partice-in-Cell Extension\n```\n\n### Module\n\nAdditionally, the validator tools can be used as *Python module* in your projects, e.g. to verify a file before opening it for reading.\n\n**Create:**\n```python\nfrom openpmd_validator import createExamples_h5\n\n\n# create \"example.h5\"\ncreateExamples_h5.main()\n```\n\n**Check:**\n```python\nfrom openpmd_validator import check_h5\n\n\nresult_array = check_h5.check_file(\"example.h5\", verbose=False)\n\nprint(\"Result: %d Errors and %d Warnings.\"\n      %( result_array[0], result_array[1]))\n```\n\n## Development\n\nThe development of these scripts is carried out *per-branch*.\nEach branch corresponds to a certain version of the standard and might\nbe updated in case tests did contain bugs or we found a way to cover more\nsections of the standard.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenpmd%2Fopenpmd-validator","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fopenpmd%2Fopenpmd-validator","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fopenpmd%2Fopenpmd-validator/lists"}