semantic-benchmark 0.1.0__tar.gz

semantic_benchmark-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Simulation-Benchmarks
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

semantic_benchmark-0.1.0/PKG-INFO

@@ -0,0 +1,89 @@
+Metadata-Version: 2.4
+Name: semantic-benchmark
+Version: 0.1.0
+Summary: Reusable helpers for semantic benchmark metadata, RO-Crate aggregation, and RoHub provenance workflows.
+Author-email: Mahdi Jafarkhani <mahdi.jafarkhani@tik.uni-stuttgart.de>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/Simulation-Benchmarks/semantic-benchmark
+Project-URL: Repository, https://github.com/Simulation-Benchmarks/semantic-benchmark.git
+Project-URL: Issues, https://github.com/Simulation-Benchmarks/semantic-benchmark/issues
+Keywords: benchmark,metadata,provenance,ro-crate,rohub
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: rdflib
+Provides-Extra: rocrate
+Requires-Dist: rocrate; extra == "rocrate"
+Requires-Dist: roc-validator; extra == "rocrate"
+Provides-Extra: rohub
+Requires-Dist: pandas; extra == "rohub"
+Requires-Dist: rohub; extra == "rohub"
+Provides-Extra: all
+Requires-Dist: pandas; extra == "all"
+Requires-Dist: roc-validator; extra == "all"
+Requires-Dist: rocrate; extra == "all"
+Requires-Dist: rohub; extra == "all"
+Dynamic: license-file
+
+# semantic-benchmark
+
+Reusable Python helpers for semantic benchmark descriptions, aggregate RO-Crate creation, and RoHub provenance workflows.
+
+## Install
+
+```bash
+pip install semantic-benchmark
+```
+
+Install optional features with extras:
+
+```bash
+pip install "semantic-benchmark[rocrate]"
+pip install "semantic-benchmark[rohub]"
+pip install "semantic-benchmark[all]"
+```
+
+To install the latest unreleased version directly from GitHub:
+
+```bash
+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:
+
+```python
+import semantic_benchmark.rohub as rohub
+
+rohub.configure_repository_settings(
+    rohub_config={...},
+)
+```

semantic_benchmark-0.1.0/README.md

@@ -0,0 +1,54 @@
+# semantic-benchmark
+
+Reusable Python helpers for semantic benchmark descriptions, aggregate RO-Crate creation, and RoHub provenance workflows.
+
+## Install
+
+```bash
+pip install semantic-benchmark
+```
+
+Install optional features with extras:
+
+```bash
+pip install "semantic-benchmark[rocrate]"
+pip install "semantic-benchmark[rohub]"
+pip install "semantic-benchmark[all]"
+```
+
+To install the latest unreleased version directly from GitHub:
+
+```bash
+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:
+
+```python
+import semantic_benchmark.rohub as rohub
+
+rohub.configure_repository_settings(
+    rohub_config={...},
+)
+```

semantic_benchmark-0.1.0/pyproject.toml

@@ -0,0 +1,60 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "semantic-benchmark"
+version = "0.1.0"
+description = "Reusable helpers for semantic benchmark metadata, RO-Crate aggregation, and RoHub provenance workflows."
+readme = "README.md"
+requires-python = ">=3.10"
+license = "MIT"
+license-files = ["LICENSE"]
+authors = [
+    { name = "Mahdi Jafarkhani", email = "mahdi.jafarkhani@tik.uni-stuttgart.de" },
+]
+keywords = ["benchmark", "metadata", "provenance", "ro-crate", "rohub"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+dependencies = [
+    "rdflib",
+]
+
+[project.optional-dependencies]
+rocrate = [
+    "rocrate",
+    "roc-validator",
+]
+rohub = [
+    "pandas",
+    "rohub",
+]
+all = [
+    "pandas",
+    "roc-validator",
+    "rocrate",
+    "rohub",
+]
+
+[project.urls]
+Homepage = "https://github.com/Simulation-Benchmarks/semantic-benchmark"
+Repository = "https://github.com/Simulation-Benchmarks/semantic-benchmark.git"
+Issues = "https://github.com/Simulation-Benchmarks/semantic-benchmark/issues"
+
+[project.scripts]
+create-semantic-benchmark-rocrate = "semantic_benchmark.rocrate.create:main"
+download-semantic-benchmark = "semantic_benchmark.rohub.download:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"semantic_benchmark.rohub" = ["*.json"]

semantic_benchmark-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

semantic_benchmark-0.1.0/src/semantic_benchmark/__init__.py

@@ -0,0 +1,37 @@
+"""Top-level package exports for semantic-benchmark."""
+
+from semantic_benchmark.semantics import (
+    BenchmarkLoader,
+    FieldMapping,
+    IOObject,
+    KGNode,
+    MathematicalModel,
+    NumericalParameter,
+    NumericalVariable,
+    ParameterEntry,
+    ParameterSet,
+    ProcessingStep,
+    Publication,
+    ResearchProblem,
+    SemanticBenchmark,
+    TextParameter,
+    Tool,
+)
+
+__all__ = [
+    "BenchmarkLoader",
+    "FieldMapping",
+    "IOObject",
+    "KGNode",
+    "MathematicalModel",
+    "NumericalParameter",
+    "NumericalVariable",
+    "ParameterEntry",
+    "ParameterSet",
+    "ProcessingStep",
+    "Publication",
+    "ResearchProblem",
+    "SemanticBenchmark",
+    "TextParameter",
+    "Tool",
+]

semantic_benchmark-0.1.0/src/semantic_benchmark/rocrate/__init__.py

@@ -0,0 +1,6 @@
+"""RO-Crate helpers for semantic benchmark outputs."""
+
+from semantic_benchmark.rocrate.create import create_main_ro
+from semantic_benchmark.rocrate.validation import validate_rocrate
+
+__all__ = ["create_main_ro", "validate_rocrate"]