dd4bench 0.0.1__tar.gz

dd4bench-0.0.1/.codespellrc

@@ -0,0 +1,7 @@
+[codespell]
+builtin = clear,rare,en-GB_to_en-US,names,informal,code
+check-filenames =
+check-hidden =
+skip = */.git,*/build,*/prefix,*tests/data,*/.vscode,*/playground,*/py-venv,CODE_OF_CONDUCT.md
+quiet-level = 2
+ignore-words-list = jupyter

dd4bench-0.0.1/.devcontainer/devcontainer.json

@@ -0,0 +1,37 @@
+// Devcontainer for local development
+// See https://github.com/key4hep/key4hep-images/ for available images
+// Requires the host have
+// a) CernVM-FS installed (see https://cvmfs.readthedocs.io/en/stable/cpt-quickstart.html for instructions)
+// b) The necessary repositories mounted on the host machine; sudo mount -t cvmfs sw.hsf.org /cvmfs/sw.hsf.org
+{
+  "name": "Key4HEP Dev",
+  "image": "ghcr.io/key4hep/key4hep-images/alma9-cvmfs:latest",
+
+  // Make sure CVMFS is mounted on the host (and bind-mounted):
+  "mounts": [
+    "source=/cvmfs,target=/cvmfs,type=bind"
+  ],
+
+  // "postCreateCommand" runs once after the container is created.
+  // Here, we append the source line to ~/.bashrc so new terminals pick it up.
+  "postCreateCommand": [
+    "bash",
+    "-c",
+    "echo 'source setup.sh' >> ~/.bashrc"
+  ],
+  // Install and activate vs code extensions for environment
+  "customizations": {
+    "vscode": {
+      "extensions": [
+        "ms-python.python",
+        "ms-toolsai.jupyter",
+        "ms-vscode.cpptools",
+        "llvm-vs-code-extensions.vscode-clangd",
+        "ms-vscode.cmake-tools",
+        "ibm.output-colorizer",
+        "charliermarsh.ruff",
+        "eamodio.gitlens"
+      ]
+    }
+  }
+}

dd4bench-0.0.1/.github/workflows/ci.yml

@@ -0,0 +1,47 @@
+name: Pipeline
+
+on:
+  push:
+    branches:
+      - main
+  pull_request:
+    branches:
+      - main
+
+env:
+  CONTAINER_IMAGE: ghcr.io/key4hep/key4hep-images/alma9
+
+jobs:
+  run:
+    runs-on: ubuntu-latest
+    steps:
+      # Checkout code
+      - uses: actions/checkout@v4
+
+      # Set up CVMFS
+      - uses: cvmfs-contrib/github-action-cvmfs@v4
+
+      # Cache Matplotlib font cache directory
+      # to speed up the tests
+      - name: Cache Matplotlib font cache
+        uses: actions/cache@v4
+        with:
+          path: .cache/matplotlib
+          key: ${{ runner.os }}-matplotlib-cache
+
+      # Build and test in the container
+      - name: Build and test
+        run: |
+          docker run --rm \
+            --device /dev/fuse \
+            --cap-add SYS_ADMIN \
+            --volume /cvmfs:/cvmfs:shared \
+            --volume ${{ github.workspace }}:/workspace \
+            --workdir /workspace \
+            -e MPLCONFIGDIR=/workspace/.cache/matplotlib \
+            ${{ env.CONTAINER_IMAGE }} bash -c "
+
+            echo '::group::Set-up key4hep'
+            source setup.sh
+            echo "Hello World"
+          "

dd4bench-0.0.1/.github/workflows/on-release-main.yml

@@ -0,0 +1,31 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+jobs:
+  publish:
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+
+    steps:
+      - uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: "3.13"
+
+      - name: Install build tools
+        run: pip install build
+
+      - name: Build
+        run: python -m build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

dd4bench-0.0.1/.gitignore

@@ -0,0 +1,21 @@
+**/.DS_Store
+.idea/
+.vs/
+.vscode/
+build/
+cmake-build-*/
+prefix/
+CMakeLists.txt.user
+compile_commands.json
+env.bat
+env.ps1
+Testing
+test/output
+__pycache__/
+*.py[cod]
+*$py.class
+*.egg-info
+playground/
+tests/output
+py-venv/
+.env

dd4bench-0.0.1/.pre-commit-config.yaml

@@ -0,0 +1,23 @@
+  - repo: https://github.com/charliermarsh/ruff-pre-commit
+    rev: "v0.15.12"
+    hooks:
+      # Run the linter.
+      - id: ruff
+        args: [ --fix ]
+      # Run the formatter.
+      - id: ruff-format
+
+  - repo: https://github.com/pre-commit/pre-commit-hooks
+    rev: "v6.0.0"
+    hooks:
+      - id: check-case-conflict
+      - id: check-merge-conflict
+      - id: check-toml
+      - id: check-yaml
+      - id: end-of-file-fixer
+      - id: trailing-whitespace
+
+  - repo: https://github.com/psf/black
+    rev: "26.3.1"
+    hooks:
+      - id: black

dd4bench-0.0.1/CODE_OF_CONDUCT.md

@@ -0,0 +1,133 @@
+
+# Contributor Covenant Code of Conduct
+
+## Our Pledge
+
+We as members, contributors, and leaders pledge to make participation in our
+community a harassment-free experience for everyone, regardless of age, body
+size, visible or invisible disability, ethnicity, sex characteristics, gender
+identity and expression, level of experience, education, socio-economic status,
+nationality, personal appearance, race, caste, color, religion, or sexual
+identity and orientation.
+
+We pledge to act and interact in ways that contribute to an open, welcoming,
+diverse, inclusive, and healthy community.
+
+## Our Standards
+
+Examples of behavior that contributes to a positive environment for our
+community include:
+
+* Demonstrating empathy and kindness toward other people
+* Being respectful of differing opinions, viewpoints, and experiences
+* Giving and gracefully accepting constructive feedback
+* Accepting responsibility and apologizing to those affected by our mistakes,
+  and learning from the experience
+* Focusing on what is best not just for us as individuals, but for the overall
+  community
+
+Examples of unacceptable behavior include:
+
+* The use of sexualized language or imagery, and sexual attention or advances of
+  any kind
+* Trolling, insulting or derogatory comments, and personal or political attacks
+* Public or private harassment
+* Publishing others' private information, such as a physical or email address,
+  without their explicit permission
+* Other conduct which could reasonably be considered inappropriate in a
+  professional setting
+
+## Enforcement Responsibilities
+
+Community leaders are responsible for clarifying and enforcing our standards of
+acceptable behavior and will take appropriate and fair corrective action in
+response to any behavior that they deem inappropriate, threatening, offensive,
+or harmful.
+
+Community leaders have the right and responsibility to remove, edit, or reject
+comments, commits, code, wiki edits, issues, and other contributions that are
+not aligned to this Code of Conduct, and will communicate reasons for moderation
+decisions when appropriate.
+
+## Scope
+
+This Code of Conduct applies within all community spaces, and also applies when
+an individual is officially representing the community in public spaces.
+Examples of representing our community include using an official email address,
+posting via an official social media account, or acting as an appointed
+representative at an online or offline event.
+
+## Enforcement
+
+Instances of abusive, harassing, or otherwise unacceptable behavior may be
+reported to the community leaders responsible for enforcement.
+
+All complaints will be reviewed and investigated promptly and fairly.
+
+All community leaders are obligated to respect the privacy and security of the
+reporter of any incident.
+
+## Enforcement Guidelines
+
+Community leaders will follow these Community Impact Guidelines in determining
+the consequences for any action they deem in violation of this Code of Conduct:
+
+### 1. Correction
+
+**Community Impact**: Use of inappropriate language or other behavior deemed
+unprofessional or unwelcome in the community.
+
+**Consequence**: A private, written warning from community leaders, providing
+clarity around the nature of the violation and an explanation of why the
+behavior was inappropriate. A public apology may be requested.
+
+### 2. Warning
+
+**Community Impact**: A violation through a single incident or series of
+actions.
+
+**Consequence**: A warning with consequences for continued behavior. No
+interaction with the people involved, including unsolicited interaction with
+those enforcing the Code of Conduct, for a specified period of time. This
+includes avoiding interactions in community spaces as well as external channels
+like social media. Violating these terms may lead to a temporary or permanent
+ban.
+
+### 3. Temporary Ban
+
+**Community Impact**: A serious violation of community standards, including
+sustained inappropriate behavior.
+
+**Consequence**: A temporary ban from any sort of interaction or public
+communication with the community for a specified period of time. No public or
+private interaction with the people involved, including unsolicited interaction
+with those enforcing the Code of Conduct, is allowed during this period.
+Violating these terms may lead to a permanent ban.
+
+### 4. Permanent Ban
+
+**Community Impact**: Demonstrating a pattern of violation of community
+standards, including sustained inappropriate behavior, harassment of an
+individual, or aggression toward or disparagement of classes of individuals.
+
+**Consequence**: A permanent ban from any sort of public interaction within the
+community.
+
+## Attribution
+
+This Code of Conduct is adapted from the [Contributor Covenant][homepage],
+version 2.1, available at
+[https://www.contributor-covenant.org/version/2/1/code_of_conduct.html][v2.1].
+
+Community Impact Guidelines were inspired by
+[Mozilla's code of conduct enforcement ladder][Mozilla CoC].
+
+For answers to common questions about this code of conduct, see the FAQ at
+[https://www.contributor-covenant.org/faq][FAQ]. Translations are available at
+[https://www.contributor-covenant.org/translations][translations].
+
+[homepage]: https://www.contributor-covenant.org
+[v2.1]: https://www.contributor-covenant.org/version/2/1/code_of_conduct.html
+[Mozilla CoC]: https://github.com/mozilla/diversity
+[FAQ]: https://www.contributor-covenant.org/faq
+[translations]: https://www.contributor-covenant.org/translations

dd4bench-0.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026, Joshua Falco Beirer
+
+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.

dd4bench-0.0.1/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.4
+Name: dd4bench
+Version: 0.0.1
+Summary: Performance benchmarking for DD4hep-based simulations and reconstruction in Key4hep
+Author-email: Joshua Falco Beirer <jbeirer@cern.ch>
+Project-URL: Repository, https://github.com/jbeirer/DD4bench
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas
+Requires-Dist: matplotlib
+Dynamic: license-file
+
+# DD4bench
+
+Performance benchmarking for DD4hep-based simulations and reconstruction in Key4hep.
+
+## Installation
+
+```bash
+pip install dd4bench
+```
+
+## Basic Usage
+
+```python
+from dd4bench import benchmark
+
+result = benchmark.ddsim(
+    compact_file="ALLEGRO_o1_v03.xml",
+    ddsim_args={
+        "numberOfEvents": 100,
+        "gun.particle": "e-",
+        "gun.distribution": "uniform",
+    },
+    scan=True,
+)
+```

dd4bench-0.0.1/README.md

@@ -0,0 +1,25 @@
+# DD4bench
+
+Performance benchmarking for DD4hep-based simulations and reconstruction in Key4hep.
+
+## Installation
+
+```bash
+pip install dd4bench
+```
+
+## Basic Usage
+
+```python
+from dd4bench import benchmark
+
+result = benchmark.ddsim(
+    compact_file="ALLEGRO_o1_v03.xml",
+    ddsim_args={
+        "numberOfEvents": 100,
+        "gun.particle": "e-",
+        "gun.distribution": "uniform",
+    },
+    scan=True,
+)
+```

dd4bench-0.0.1/dd4bench/__init__.py

@@ -0,0 +1,8 @@
+"""DD4bench — performance benchmarking for DD4hep-based simulations and reconstruction in Key4hep."""
+
+from importlib.metadata import version, PackageNotFoundError
+
+try:
+    __version__ = version("dd4bench")
+except PackageNotFoundError:
+    __version__ = "unknown"

dd4bench-0.0.1/dd4bench.egg-info/PKG-INFO

@@ -0,0 +1,38 @@
+Metadata-Version: 2.4
+Name: dd4bench
+Version: 0.0.1
+Summary: Performance benchmarking for DD4hep-based simulations and reconstruction in Key4hep
+Author-email: Joshua Falco Beirer <jbeirer@cern.ch>
+Project-URL: Repository, https://github.com/jbeirer/DD4bench
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas
+Requires-Dist: matplotlib
+Dynamic: license-file
+
+# DD4bench
+
+Performance benchmarking for DD4hep-based simulations and reconstruction in Key4hep.
+
+## Installation
+
+```bash
+pip install dd4bench
+```
+
+## Basic Usage
+
+```python
+from dd4bench import benchmark
+
+result = benchmark.ddsim(
+    compact_file="ALLEGRO_o1_v03.xml",
+    ddsim_args={
+        "numberOfEvents": 100,
+        "gun.particle": "e-",
+        "gun.distribution": "uniform",
+    },
+    scan=True,
+)
+```

dd4bench-0.0.1/dd4bench.egg-info/SOURCES.txt

@@ -0,0 +1,19 @@
+.codespellrc
+.gitignore
+.pre-commit-config.yaml
+CODE_OF_CONDUCT.md
+LICENSE
+README.md
+pyproject.toml
+requirements.txt
+setup.sh
+.devcontainer/devcontainer.json
+.github/workflows/ci.yml
+.github/workflows/on-release-main.yml
+dd4bench/__init__.py
+dd4bench.egg-info/PKG-INFO
+dd4bench.egg-info/SOURCES.txt
+dd4bench.egg-info/dependency_links.txt
+dd4bench.egg-info/entry_points.txt
+dd4bench.egg-info/requires.txt
+dd4bench.egg-info/top_level.txt

dd4bench-0.0.1/dd4bench.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

dd4bench-0.0.1/dd4bench.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+dd4bench = dd4bench.cli:main

dd4bench-0.0.1/dd4bench.egg-info/requires.txt

@@ -0,0 +1,2 @@
+pandas
+matplotlib

dd4bench-0.0.1/dd4bench.egg-info/top_level.txt

@@ -0,0 +1 @@
+dd4bench

dd4bench-0.0.1/pyproject.toml

@@ -0,0 +1,38 @@
+[project]
+name = "dd4bench"
+dynamic = ["version"]
+description = "Performance benchmarking for DD4hep-based simulations and reconstruction in Key4hep"
+authors = [{name = "Joshua Falco Beirer", email = "jbeirer@cern.ch"}]
+readme = "README.md"
+requires-python = ">=3.13"
+# Intended to run inside the Key4hep environment; dependency versions
+# are determined by the Key4hep stack, so no version constraints are set.
+dependencies = [
+    "pandas",
+    "matplotlib",
+]
+
+[project.urls]
+Repository = "https://github.com/jbeirer/DD4bench"
+
+[project.scripts]
+dd4bench = "dd4bench.cli:main"
+
+[build-system]
+requires = ["setuptools>=64", "setuptools-scm>=8"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools.packages.find]
+include = ["dd4bench*"]
+
+[tool.setuptools_scm]
+# version is derived automatically from git tags
+
+[tool.pytest.ini_options]
+markers = [
+    "integration: requires full Key4hep environment with ddsim",
+]
+
+[tool.ruff]
+line-length = 100
+target-version = "py313"

dd4bench-0.0.1/requirements.txt

@@ -0,0 +1,2 @@
+codespell==2.4.2
+pre-commit==4.6.0

dd4bench-0.0.1/setup.cfg

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

dd4bench-0.0.1/setup.sh

@@ -0,0 +1,74 @@
+#!/bin/bash
+
+# Use environment variable if set, otherwise use default version
+KEY4HEP_VERSION=${KEY4HEP_VERSION:-"2026-04-08"}
+
+# Setup Key4HEP environment only if not already set
+if [ -z "$KEY4HEP_STACK" ]; then
+    source /cvmfs/sw.hsf.org/key4hep/setup.sh -r "${KEY4HEP_VERSION}"
+else
+    echo "✅ KEY4HEP_STACK is already set. Skipping Key4HEP environment setup."
+fi
+
+# Set up python virtual environment only if it doesn't exist
+mkdir -p ~/.local/bin
+export PATH=~/.local/bin:"${PATH}"
+
+# Download cvmfs-venv script if not already present
+if [ ! -f ~/.local/bin/cvmfs-venv ]; then
+    curl -sL https://raw.githubusercontent.com/jbeirer/cvmfs-venv/main/cvmfs-venv.sh -o ~/.local/bin/cvmfs-venv
+    chmod +x ~/.local/bin/cvmfs-venv
+fi
+
+# Check if the virtual environment already exists
+if [ ! -d "py-venv" ]; then
+    cvmfs-venv py-venv
+else
+    echo "✅ Virtual environment 'py-venv' already exists. Skipping creation."
+fi
+
+# Check if the virtual environment is already activated
+if [ -z "$VIRTUAL_ENV" ]; then
+    echo "🔄 Activating virtual environment..."
+    . py-venv/bin/activate
+else
+    echo "✅ Virtual environment is already active."
+fi
+
+# Check if all required Python dependencies are installed
+pip install --quiet --no-dependencies -r requirements.txt
+
+# Check if pre-commit is already installed
+if ! pre-commit --version &>/dev/null; then
+    echo "🔄 Installing pre-commit hooks..."
+    pre-commit install
+else
+    echo "✅ Pre-commit hooks are already installed."
+fi
+
+# Capture all environment variables for the current session
+# This allows us to use jupyter notebooks in the key4hep environment
+ENV_FILE=".env"
+echo "🔄 Saving all environment variables to .env file..."
+
+# Use printenv to retrieve all environment variables and format them for a .env file.
+#
+# Exclusions:
+# 1) Exclude PKG_CONFIG_PATH to prevent "execvp(3) failed: Argument list too long."
+#    - There is nothing special about PKG_CONFIG_PATH, but it is long and unnecessary.
+# 2) Exclude all SINGULARITY and APPTAINER-related variables.
+#    - This helps avoid potential conflicts or issues with Singularity/Apptainer.
+
+EXCLUDE_PATTERNS=(
+    PKG_CONFIG_PATH 
+    ".*SINGULARITY.*"
+    ".*APPTAINER.*"
+    ALRB_CONT_IMAGE
+)
+# Convert patterns into a grep-compatible regex
+EXCLUDE_REGEX="$(printf "|%s" "${EXCLUDE_PATTERNS[@]}" | cut -c2-)"
+
+printenv | grep -vE "^(${EXCLUDE_REGEX})=" \
+    | awk -F= '{print $1"=\"" $2 "\""}' > "$ENV_FILE"
+
+echo "✅ .env file created successfully."