refactor!: rename project from eic-opticks to simphony by plexoos · Pull Request #298 · BNLNPPS/simphony

plexoos · 2026-04-20T18:56:55Z

Rename project-facing identifiers from eic-opticks to simphony across docs, scripts, examples, CMake package usage, and installed include paths.
Update downstream example builds to use find_package(simphony) and simphony::... targets.
Rename the DD4hep plugin identity from ddeicopticks / libddeicopticks.so to ddsimphony / libddsimphony.so.

Breaking Changes

Downstream CMake users should now use find_package(simphony) instead of find_package(eic-opticks).
Exported targets now use the simphony:: namespace.
Installed headers are included under simphony/....
DD4hep plugin loading should use libddsimphony.so.

chatgpt-codex-connector

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 7b8ef8baec

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Copilot

Pull request overview

Updates project documentation to reflect the rename from eic-opticks to simphony/Simphony, including repository URLs and container image references, so new users follow the renamed project identity consistently.

Changes:

Rename project references in the root README (clone/build, Docker/Singularity examples, and narrative text).
Rename project reference in examples/README.md.

Reviewed changes

Copilot reviewed 2 out of 2 changed files in this pull request and generated 3 comments.

File	Description
examples/README.md	Updates example prerequisites text to refer to Simphony installation.
README.md	Updates repo/image names and narrative references from eic-opticks to simphony/Simphony across usage sections.

Comments suppressed due to low confidence (1)

README.md:90

README instructs users to run sbatch scripts/submit.sh, but scripts/submit.sh in the repo still references eic-opticks (job name, image name, and /src/eic-opticks path). Either update scripts/submit.sh as part of this rename, or adjust the README to tell users to edit the script placeholders/paths accordingly.

To submit a test run of `simphony` on Perlmutter, use the following example. Make sure to update
any placeholder values as needed.

sbatch scripts/submit.sh

</details>



---

💡 <a href="/BNLNPPS/eic-opticks/new/main?filename=.github/instructions/*.instructions.md" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Add Copilot custom instructions</a> for smarter, more guided reviews. <a href="https://docs.github.com/en/copilot/customizing-copilot/adding-repository-custom-instructions-for-github-copilot" class="Link--inTextBlock" target="_blank" rel="noopener noreferrer">Learn how to get started</a>.

Copilot · 2026-04-20T18:59:44Z

+Assuming Simphony is properly installed on the system, compile and run this
 example by simply doing from this directory:


This example README now says “Assuming Simphony is properly installed…”, but the accompanying build setup still uses find_package(eic-opticks REQUIRED) and links eic-opticks::... targets (see examples/CMakeLists.txt). Either update this README to reference the actual CMake package name users must have installed, or rename the exported CMake package/targets to match “Simphony” so the instructions are accurate.

Suggested change

Assuming Simphony is properly installed on the system, compile and run this

example by simply doing from this directory:

Assuming the `eic-opticks` CMake package is properly installed on the system,

compile and run this example by simply doing from this directory:

Copilot · 2026-04-20T18:59:45Z

+docker run --rm -it -v $HOME:/esi -v $HOME/simphony:/workspaces/simphony -e DISPLAY=$DISPLAY -e HOME=/esi --net=host ghcr.io/bnlnpps/simphony:develop

-docker run ghcr.io/bnlnpps/eic-opticks bash -c 'simg4ox -g tests/geom/sphere_leak.gdml -m tests/run.mac -c sphere_leak'
+docker run ghcr.io/bnlnpps/simphony bash -c 'simg4ox -g tests/geom/sphere_leak.gdml -m tests/run.mac -c sphere_leak'


This docker run example uses ghcr.io/bnlnpps/simphony without an explicit tag, while the other examples in this section use :develop. Consider using a consistent tag (e.g. :develop or :latest) so readers don’t accidentally run a different image than intended.

Suggested change

docker run ghcr.io/bnlnpps/simphony bash -c 'simg4ox -g tests/geom/sphere_leak.gdml -m tests/run.mac -c sphere_leak'

docker run ghcr.io/bnlnpps/simphony:develop bash -c 'simg4ox -g tests/geom/sphere_leak.gdml -m tests/run.mac -c sphere_leak'

Copilot · 2026-04-20T18:59:45Z

+docker build -t simphony:perf-dev --target=develop
+docker run --rm -t -v /tmp/out:/tmp/out simphony:perf-dev run-performance -o /tmp/out/dev

-docker build -t eic-opticks:perf-rel --target=release
-docker run --rm -t -v /tmp/out:/tmp/out eic-opticks:perf-rel run-performance -o /tmp/out/rel
+docker build -t simphony:perf-rel --target=release
+docker run --rm -t -v /tmp/out:/tmp/out simphony:perf-rel run-performance -o /tmp/out/rel


These docker build commands are missing the required build context argument (e.g. .). As written, docker build -t ... --target=... will fail; please add the context path (and optionally -f Dockerfile if needed).

plexoos · 2026-05-06T23:50:07Z

@ggalgoczi If you have anything to contribute to this PR please do so asap

ggalgoczi · 2026-05-08T00:10:57Z

Thank you for this PR, I agree this is very important. I have the following comments, questions:

Devcontainer/README/scripts point at GHCR images and a GitHub URL that don't yet exist. As-merged, this PR breaks the documented one-liner in README.md:39 (git clone https://github.com/BNLNPPS/simphony.git) and the devcontainer cache reference in .devcontainer/devcontainer.json:12 (ghcr.io/bnlnpps/simphony:base). CI in .github/workflows/build-push.yaml:62 derives IMAGE_NAME from ${{ github.repository }}
Do you want a CHANGELOG entry or a version bump with this PR?
We should rename the dd4hep plugins and all links from there. I can do this in an other PR if you think that is better.
I think migration footer is incomplete: Consumers will additionally need to update: Raw includes, Install prefix, Shifter mount path used by scripts/submit.sh:15: cd /src/eic-opticks

ggalgoczi

Please see my review comments in previous comment on the thread

plexoos · 2026-05-19T22:47:59Z

Please see my review comments in previous comment on the thread

Feel free to update anything you think is missing.

Do you want a CHANGELOG entry or a version bump with this PR?

I’d prefer automatically generated CHANGELOG updates. At the moment, I’m not sure we want to duplicate what is already shown on the release page: https://github.com/BNLNPPS/simphony/releases

We should rename the dd4hep plugins and all links from there. I can do this in an other PR if you think that is better.

Either approach is fine with me.

I think migration footer is incomplete: Consumers will additionally need to update: Raw includes, Install prefix, Shifter mount path used by scripts/submit.sh:15: cd /src/eic-opticks

Yes, agreed.

Rename project-facing identifiers and references from eic-opticks to simphony across build, container, examples, scripts, and DD4hep plugin docs. - CMake: project name and downstream package usage switched to simphony - Examples: update find_package/target namespaces and include paths - Devcontainer: rename container names and GHCR base image references - Dockerfile: update OPTICKS_* install/home/build paths to /opt/simphony and /workspaces/simphony - Scripts/docs: rename job/image/path and user-facing text references BREAKING CHANGE: CMake consumers must migrate from find_package(eic-opticks) and eic-opticks::* targets/includes to find_package(simphony) and simphony::*.

Rename remaining DD4hep plugin identifiers to ddsimphony and update standalone examples, include paths, scripts, and docs to use simphony.

Copilot

Pull request overview

Copilot reviewed 28 out of 28 changed files in this pull request and generated no new comments.

plexoos · 2026-05-29T15:18:38Z

@codex review

addressed

chatgpt-codex-connector · 2026-05-29T15:21:54Z

Codex Review: Didn't find any major issues. You're on a roll.

ℹ️ About Codex in GitHub

Your team has set up Codex to review pull requests in this repo. Reviews are triggered when you

Open a pull request for review
Mark a draft as ready
Comment "@codex review".

If Codex has suggestions, it will comment; otherwise it will react with 👍.

Codex can also answer questions or update the PR. Try commenting "@codex address that feedback".

Copilot AI review requested due to automatic review settings April 20, 2026 18:56

plexoos added documentation Improvements or additions to documentation refactor labels Apr 20, 2026

Copilot started reviewing on behalf of plexoos April 20, 2026 18:57 View session

plexoos added this to the 1.0.0 milestone Apr 20, 2026

plexoos added this to simphony Apr 20, 2026

github-project-automation Bot moved this to Backlog in simphony Apr 20, 2026

plexoos linked an issue Apr 20, 2026 that may be closed by this pull request

Rename repository from eic-opticks to simphony #241

Open

4 tasks

chatgpt-codex-connector Bot reviewed Apr 20, 2026

View reviewed changes

Comment thread README.md

Comment thread README.md

Copilot AI reviewed Apr 20, 2026

View reviewed changes

plexoos assigned plexoos and ggalgoczi Apr 21, 2026

plexoos changed the title ~~docs(readme): rename project to simphony~~ docs: rename project to simphony May 7, 2026

ggalgoczi self-requested a review May 8, 2026 00:11

ggalgoczi previously requested changes May 8, 2026

View reviewed changes

ggalgoczi mentioned this pull request May 9, 2026

docs: add geometry requirements guide for optical photon simulation #305

Open

plexoos force-pushed the rename-proj branch 2 times, most recently from 18f1a4f to d575abe Compare May 19, 2026 22:40

plexoos added 2 commits May 29, 2026 10:38

docs(readme): rename project to simphony

c2d3adf

plexoos force-pushed the rename-proj branch from 273fdf1 to ce03781 Compare May 29, 2026 14:39

refactor!: complete eic-opticks to simphony rename

f8867db

Rename remaining DD4hep plugin identifiers to ddsimphony and update standalone examples, include paths, scripts, and docs to use simphony.

plexoos requested a review from Copilot May 29, 2026 15:11

Copilot started reviewing on behalf of plexoos May 29, 2026 15:11 View session

plexoos changed the title ~~docs: rename project to simphony~~ refactor!: rename project from eic-opticks to simphony May 29, 2026

Copilot AI reviewed May 29, 2026

View reviewed changes

		Assuming Simphony is properly installed on the system, compile and run this
		example by simply doing from this directory:

	docker run ghcr.io/bnlnpps/simphony bash -c 'simg4ox -g tests/geom/sphere_leak.gdml -m tests/run.mac -c sphere_leak'
	docker run ghcr.io/bnlnpps/simphony:develop bash -c 'simg4ox -g tests/geom/sphere_leak.gdml -m tests/run.mac -c sphere_leak'

Conversation

plexoos commented Apr 20, 2026 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Breaking Changes

Uh oh!

chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

💡 Codex Review

Uh oh!

Uh oh!

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Reviewed changes

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

Copilot AI Apr 20, 2026

Choose a reason for hiding this comment

Uh oh!

plexoos commented May 6, 2026

Uh oh!

ggalgoczi commented May 8, 2026

Uh oh!

ggalgoczi left a comment

Choose a reason for hiding this comment

Uh oh!

plexoos commented May 19, 2026

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull request overview

Uh oh!

plexoos commented May 29, 2026

Uh oh!

chatgpt-codex-connector Bot commented May 29, 2026

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

plexoos commented Apr 20, 2026 •

edited

Loading