Skip to main content

Reusable helpers for semantic benchmark metadata, RO-Crate aggregation, and RoHub provenance workflows.

Project description

semantic-benchmark

Reusable Python helpers for semantic benchmark descriptions, aggregate RO-Crate creation, and RoHub provenance workflows.

Install

pip install semantic-benchmark

Install optional features with extras:

pip install "semantic-benchmark[rocrate]"
pip install "semantic-benchmark[rohub]"
pip install "semantic-benchmark[all]"

To install the latest unreleased version directly from GitHub:

pip install "semantic-benchmark[all] @ git+https://github.com/Simulation-Benchmarks/semantic-benchmark.git"

Provided Modules

  • semantic_benchmark.semantics: dataclasses and BenchmarkLoader for JSON-LD benchmark descriptions.
  • semantic_benchmark.rohub: RoHub configuration, upload, download, annotation, and query helpers.
  • semantic_benchmark.rocrate: aggregate RO-Crate creation and validation helpers.

semantic_benchmark.semantics is available from the base installation. semantic_benchmark.rocrate requires the rocrate extra. semantic_benchmark.rohub requires the rohub extra.

The root semantic_benchmark package re-exports the semantic classes for backwards compatibility. The legacy semantic_benchmark.semantic module also remains as a compatibility shim.

semantic_benchmark.rohub.download_benchmark_resources(...) downloads the software source code and annotation collection resources from a RoHub research object. The package also exposes the download-semantic-benchmark CLI.

semantic_benchmark.rocrate.create_main_ro(...) can validate the generated aggregate crate by passing validation_profile. The package writes the RO-Crate zip, unpacks it to a validation directory, and runs validate_rocrate(...).

Repository-specific projects can override the packaged RoHub defaults with:

import semantic_benchmark.rohub as rohub

rohub.configure_repository_settings(
    rohub_config={...},
)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

semantic_benchmark-0.1.1.tar.gz (20.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

semantic_benchmark-0.1.1-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

Details for the file semantic_benchmark-0.1.1.tar.gz.

File metadata

  • Download URL: semantic_benchmark-0.1.1.tar.gz
  • Upload date:
  • Size: 20.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.12.4

File hashes

Hashes for semantic_benchmark-0.1.1.tar.gz
Algorithm Hash digest
SHA256 7621a22c60d97b8e663093b70bd25795c2162a05ae3e0a684a855dd3fb4fbf36
MD5 6b8dd4abb3286b179b6ff2da5b95840a
BLAKE2b-256 9d4e88456a553b96972e9e2d2cf84bc21bbe05742d9a27abd5740bac1eb5c659

See more details on using hashes here.

File details

Details for the file semantic_benchmark-0.1.1-py3-none-any.whl.

File metadata

File hashes

Hashes for semantic_benchmark-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 a4a6ab9680ef694b19eb9463f4e570ce5fec2f1b38f9971abc591ae9cf8e7a7d
MD5 bc2b7fb4942ed974bc503f3e72dc9948
BLAKE2b-256 dbaa8ded9b36facd39672ba8d752112a36abe9483b6456dfd40bb002522facfc

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page