Skip to content

Consume shipdatamodel 0.3.0 and drop the data-model overlay#11

Merged
olantwin merged 1 commit into
mainfrom
build/drop-datamodel-overlay
Jul 23, 2026
Merged

Consume shipdatamodel 0.3.0 and drop the data-model overlay#11
olantwin merged 1 commit into
mainfrom
build/drop-datamodel-overlay

Conversation

@olantwin

@olantwin olantwin commented Jul 23, 2026

Copy link
Copy Markdown
Collaborator

The RecHit and per-detector hit classes Shannon needs now ship in the released shipdatamodel 0.3.0 (published to prefix.dev/ship), so the .local-deps overlay that built data-model from pull/5/head is no longer needed.

Changes

  • Pin shipdatamodel >=0.3 and resolve it straight from the conda env.
  • Drop the fetch/configure/build/install-datamodel pixi tasks, the .local-deps LD_LIBRARY_PATH activation (both in pixi.toml and activate.sh), and the -DSHiPDataModel_DIR=…/.local-deps/… configure override.
  • Remove the DT_RUNPATH (--enable-new-dtags) linker workaround — it existed only so the overlay could shadow the released shipdatamodel; default conda RPATH now points at the correct shipdatamodel in the env. The unrelated --no-as-needed block (DT_NEEDED for ROOT dictionary deps) is kept.
  • .gitignore: drop the now-dead .local-deps/ entry.
  • pixi.lock: re-solved; shipdatamodel 0.1.0 → 0.3.0.

Verification

Locally, with no sibling ../data-model checkout: pixi install resolves shipdatamodel 0.3.0, pixi run build compiles all three plugins against the conda package, and pixi run smoke passes end to end ("Smoke test OK") — confirming the RecHit/detector types resolve at runtime without the overlay or the RUNPATH workaround.

Summary by CodeRabbit

  • Enhancements

    • Improved runtime setup for resolving geometry data by filename.
    • Simplified build configuration and runtime library path handling.
  • Bug Fixes

    • Removed reliance on locally overlaid data-model artifacts during configuration.
    • Updated the supported shipdatamodel version requirement to 0.3 or newer.
  • Chores

    • Retired obsolete data-model fetching, configuration, build, and installation tasks.

The RecHit and per-detector hit headers Shannon needs now ship in the
released shipdatamodel 0.3.0 (on prefix.dev/ship), so the .local-deps
overlay that built data-model from pull/5/head is no longer required.

- pin shipdatamodel >=0.3 and resolve it from the conda env
- drop the fetch/configure/build/install-datamodel tasks, the
  .local-deps LD_LIBRARY_PATH activation, and the SHiPDataModel_DIR
  configure override
- remove the DT_RUNPATH linker workaround, which existed only so the
  overlay could shadow the released shipdatamodel; default conda RPATH
  now points at the correct shipdatamodel in the env
@coderabbitai

coderabbitai Bot commented Jul 23, 2026

Copy link
Copy Markdown

Review Change Stack

📝 Walkthrough

Walkthrough

The project now requires shipdatamodel >= 0.3, removes the local data-model build overlay, updates linker flags, and configures geometry database resolution through SHIPGEOMETRY_ROOT.

Changes

Build environment

Layer / File(s) Summary
Data-model dependency and task wiring
pixi.toml, .gitignore
The data-model dependency is constrained to >= 0.3; overlay tasks, related environment setup, and .local-deps/ ignoring are removed.
Linker and runtime environment
CMakeLists.txt, activate.sh
CMake retains --no-as-needed for shared and module targets, while activation exports SHIPGEOMETRY_ROOT and removes the local data-model library path.

Estimated code review effort: 2 (Simple) | ~10 minutes

Suggested reviewers: mesmith75

🚥 Pre-merge checks | ✅ 4 | ❌ 1

❌ Failed checks (1 warning)

Check name Status Explanation Resolution
Description check ⚠️ Warning The description covers changes and verification, but it omits the template's required checklist items. Add the Checklist section with the three required items: conventional commit message, pre-commit checks, and CI checks.
✅ Passed checks (4 passed)
Check name Status Explanation
Title check ✅ Passed The title matches the main change: adopting shipdatamodel 0.3.0 and removing the data-model overlay.
Docstring Coverage ✅ Passed No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.
Linked Issues check ✅ Passed Check skipped because no linked issues were found for this pull request.
Out of Scope Changes check ✅ Passed Check skipped because no linked issues were found for this pull request.
✨ Finishing Touches
📝 Generate docstrings
  • Create stacked PR
  • Commit on current branch
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch build/drop-datamodel-overlay

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

Comment @coderabbitai help to get the list of available commands.

@coderabbitai coderabbitai Bot left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Actionable comments posted: 1

🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

Inline comments:
In `@pixi.toml`:
- Line 12: Update the shipdatamodel dependency constraint in the manifest to
match the package’s supported range, requiring at least 0.3.0 and excluding
0.4.0a0 and later releases.
🪄 Autofix (Beta)

Fix all unresolved CodeRabbit comments on this PR:

  • Push a commit to this branch (recommended)
  • Create a new PR with the fixes

ℹ️ Review info
⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro Plus

Run ID: 459b8b77-79ed-4115-a2b3-1d02bbdfa6a6

📥 Commits

Reviewing files that changed from the base of the PR and between 6d077a6 and 50f4fd7.

⛔ Files ignored due to path filters (1)
  • pixi.lock is excluded by !**/*.lock
📒 Files selected for processing (4)
  • .gitignore
  • CMakeLists.txt
  • activate.sh
  • pixi.toml
💤 Files with no reviewable changes (3)
  • .gitignore
  • CMakeLists.txt
  • activate.sh

Comment thread pixi.toml
[dependencies]
# SHiP/HEP packages (prefix.dev/ship + conda-forge)
shipdatamodel="*"
shipdatamodel = ">=0.3"

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🗄️ Data Integrity & Integration | 🟠 Major | ⚡ Quick win

🧩 Analysis chain

🏁 Script executed:

#!/bin/bash
set -euo pipefail

echo "== files =="
git ls-files | rg '(^|/)pixi\.(toml|lock)$|CMakeLists\.txt$|CMake' || true

echo "== pixi.toml =="
if [ -f pixi.toml ]; then cat -n pixi.toml; fi

echo "== relevant pixi.lock snippets =="
if [ -f pixi.lock ]; then
  rg -n -C 4 'shipdatamodel|shipdatamodel-|ship-data|ShipDataModel|SHiPDataModel' pixi.lock || true
fi

echo "== CMake references =="
rg -n -C 4 'SHiPDataModel|shipdatamodel|find_package|CONDA_PREFIX|pixi run|conda activate' . --glob '!pixi.lock' --glob '!node_modules' --glob '!dist' --glob '!build' || true

Repository: ShipSoft/Shannon

Length of output: 13866


Keep the manifest constraint aligned with the resolved compatibility range.

pixi.toml accepts any future shipdatamodel >=0.3, but the package exports the narrower shipdatamodel >=0.3.0,<0.4.0a0 compatibility range. If 0.4 is not supported by this project, encode that upper bound in the manifest so lockfile re-solves cannot select an incompatible release.

🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.

In `@pixi.toml` at line 12, Update the shipdatamodel dependency constraint in the
manifest to match the package’s supported range, requiring at least 0.3.0 and
excluding 0.4.0a0 and later releases.

@olantwin
olantwin merged commit f731a93 into main Jul 23, 2026
4 checks passed
@olantwin
olantwin deleted the build/drop-datamodel-overlay branch July 23, 2026 12:54
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant