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.4.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.4-py3-none-any.whl (23.1 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: semantic_benchmark-0.1.4.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.4.tar.gz
Algorithm Hash digest
SHA256 9ce806ca5e7cc0f5687d37292e59aeffe92744a67f7b8f7719d05a493416507d
MD5 ed935c06a1fbcdffb127a9aceb453c01
BLAKE2b-256 e937f0b877cfcc769206f305ffabcf52267e8cce192c7bd3f56df6aa230e4a8f

See more details on using hashes here.

File details

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

File metadata

File hashes

Hashes for semantic_benchmark-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 d7293493e5d99131452f423f99cd094a85afaa4b1d8071817450d4b34bb3748a
MD5 ac38991e470aeb22ebe1346b1b7449f2
BLAKE2b-256 2ce080fd12f8250658f323f77d428754d255ae817a921c64ad07e233b4ccfa91

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