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.0.tar.gz (20.9 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.0-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: semantic_benchmark-0.1.0.tar.gz
  • Upload date:
  • Size: 20.9 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.0.tar.gz
Algorithm Hash digest
SHA256 1195105f3e9f3b7cc034fa97ee956e5c9330cab5bb2cdcd46d88059bc5612b3e
MD5 cd3463477b6107fe59d38d6694e2902f
BLAKE2b-256 4aa3f2211201d2e0ac2ed149b2456a0deea9a3f5f583eaab29b8a2af0530f6e0

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for semantic_benchmark-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 90aaeaa6d3e66c9283e4de816f5acafc9c58cdb6cc3bfdafd375ed497363d22a
MD5 d95ec4d9cdd95c0fc0f7d681e3502782
BLAKE2b-256 0dfd745107f44dca8a7b823eed46a019052a032a2a58b02794b503b468eda880

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