Skip to content

refactor(core): remove legacy WITH_(SLOG|STTF) and image-output paths#321

Merged
plexoos merged 3 commits into
mainfrom
remove-with-slog
May 18, 2026
Merged

refactor(core): remove legacy WITH_(SLOG|STTF) and image-output paths#321
plexoos merged 3 commits into
mainfrom
remove-with-slog

Conversation

@plexoos
Copy link
Copy Markdown
Member

@plexoos plexoos commented May 4, 2026

This branch finishes removing several legacy paths that are no longer part of the supported simphony workflow.

What changed

  • removed deprecated WITH_SLOG and WITH_STTF guard logic
  • removed STTF text-annotation code and related tests
  • removed SIMG image-output wrappers and bundled stb_* headers
  • simplified u4 optical-process instrumentation to the supported in-tree path
  • switched render snapshot output from annotated image files to raw .npy frame dumps with metadata

Why

This codebase no longer aims to support the old workflow with in-repo visualization/image publishing paths. Those branches had become stale, added dead conditional code, and were already drifting out of sync with the supported build.

Most of the large deletion count in this PR comes from removing bundled image/font helper headers and their tests.

Copilot AI review requested due to automatic review settings May 4, 2026 23:47
@plexoos plexoos changed the title irefactor(build): remove deprecated WITH_SLOG and WITH_STTF guards refactor(build): remove deprecated WITH_SLOG and WITH_STTF guards May 4, 2026
@plexoos plexoos self-assigned this May 4, 2026
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: 1aa8869bc9

ℹ️ 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".

Comment thread sysrap/OpticksPhoton.hh
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

This PR simplifies the build by removing the deprecated WITH_SLOG and WITH_STTF guards that were effectively always enabled, and by making the associated logging/font code paths unconditional across SysRap/CSG-related code.

Changes:

  • Removed obsolete WITH_SLOG / WITH_STTF compile definitions from CMake and PTX build settings.
  • Made SLOG usage in CSG::CU and OpticksPhoton unconditional, and always registered STTFTest.cc.
  • Deleted legacy SLOG documentation files and replaced them with short inline header notes.

Reviewed changes

Copilot reviewed 13 out of 13 changed files in this pull request and generated 1 comment.

Show a summary per file
File Description
u4/CMakeLists.txt Minor cleanup of stale blank line near compile definitions.
sysrap/tests/CMakeLists.txt Registers STTFTest.cc unconditionally in SysRap tests.
sysrap/SLOG.rst Deletes legacy standalone SLOG documentation.
sysrap/SLOG.hh Replaces external doc reference with short inline logging note.
sysrap/SLOG_review.rst Deletes old SLOG review/design notes.
sysrap/OpticksPhoton.hh Makes plog severity declaration/header dependency unconditional.
sysrap/OpticksPhoton.cc Makes SLOG include and LEVEL definition unconditional.
sysrap/OPTICKS_LOG.hh Adds inline note describing SLOG.hh / SLOG_INIT.hh roles.
sysrap/CMakeLists.txt Removes deprecated guard variables/definitions; always installs STTF headers.
qudarap/CMakeLists.txt Removes stale local-debugging comment block.
CSGOptiX/CMakeLists.txt Drops deprecated guard definitions from PTX object compilation.
CSG/CU.h Makes plog severity dependency unconditional in CU.
CSG/CU.cc Makes SLOG include, level, and logging calls unconditional.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

Comment thread sysrap/OpticksPhoton.hh
@plexoos plexoos force-pushed the remove-with-slog branch 7 times, most recently from bd55f66 to 8c302eb Compare May 13, 2026 15:18
@plexoos
Copy link
Copy Markdown
Member Author

plexoos commented May 13, 2026

@codex review

@plexoos plexoos changed the title refactor(build): remove deprecated WITH_SLOG and WITH_STTF guards refactor(core): remove legacy standalone and image-output paths May 13, 2026
Copy link
Copy Markdown

@chatgpt-codex-connector chatgpt-codex-connector Bot left a comment

Choose a reason for hiding this comment

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

💡 Codex Review

Here are some automated review suggestions for this pull request.

Reviewed commit: e7678d43dd

ℹ️ 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".

Comment thread CSGOptiX/CSGOptiX.cc

bool unique = true ;
const char* outpath = SEventConfig::OutPath(stem, -1, ".jpg", unique );
const char* outpath = SEventConfig::OutPath(stem, -1, ".npy", unique);
Copy link
Copy Markdown

Choose a reason for hiding this comment

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

P1 Badge Preserve snapshot image output format

Changing render_save_ to emit .npy (SEventConfig::OutPath(..., ".npy", ...)) turns renderer snapshots into raw arrays instead of image files, which breaks existing CSGOptiX workflows that consume .jpg frames (for example CSGOptiX/cxr_flight.sh expects *_00000.jpg and invokes ffmpeg_jpg_to_mp4.sh, and CSGOptiX/grab.sh syncs *.jpg). In practice, users pressing snap in interactive/render scripts will no longer produce the files those downstream tools are built around.

Useful? React with 👍 / 👎.

Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Confirmed, the observation is technically correct: this PR changes renderer snapshots from .jpg image output to .npy frame dumps while some legacy CSGOptiX scripts still assume .jpg frames. That said, preserving .jpg output is not the direction of this PR; in-repo visualization/image publishing is being retired. I’ll treat the remaining JPG-oriented scripts/docs as follow-up cleanup rather than restoring the old SIMG/STTF image path.

@plexoos
Copy link
Copy Markdown
Member Author

plexoos commented May 15, 2026

@copilot review

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 41 out of 43 changed files in this pull request and generated 1 comment.

Comment thread sysrap/SRenderer.hh Outdated
@plexoos
Copy link
Copy Markdown
Member Author

plexoos commented May 15, 2026

@codex review

@chatgpt-codex-connector
Copy link
Copy Markdown

Codex Review: Didn't find any major issues. More of your lovely PRs please.

ℹ️ 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".

plexoos added 3 commits May 18, 2026 09:46
Remove the remaining WITH_SLOG compile definitions from sysrap and CSGOptiX.

Delete the conditional logging includes, LEVEL declarations, and debug-only LOG calls in CSG::CU and
OpticksPhoton now that the flag no longer controls functional behavior.

This simplifies the build configuration and removes dead code without changing runtime logic.
- drop the STTF/stb_truetype implementation and font path config
- remove SIMG/Frame/CSGOptiX annotation hooks and simplify SRenderer::snap
- delete STTF-specific tests and stop SIMGTest from expecting text overlays
- drop the SIMG/SIMG_Frame wrappers and bundled stb image headers
- switch SGLFW and CSGOptiX snapshot output from jpg/png to raw npy buffers
- remove SIMG-dependent tests and the qudarap image rotation test
@plexoos plexoos force-pushed the remove-with-slog branch from 8e0d3ae to e87da56 Compare May 18, 2026 13:49
Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

Copilot reviewed 41 out of 43 changed files in this pull request and generated 1 comment.

Comment thread u4/Local_DsG4Scintillation.cc
@plexoos plexoos force-pushed the remove-with-slog branch 2 times, most recently from 6670bed to 0b4c8f1 Compare May 18, 2026 16:43
@plexoos
Copy link
Copy Markdown
Member Author

plexoos commented May 18, 2026

@codex review

Copy link
Copy Markdown
Contributor

Copilot AI left a comment

Choose a reason for hiding this comment

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

Pull request overview

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

@chatgpt-codex-connector
Copy link
Copy Markdown

Codex Review: Didn't find any major issues. Nice work!

ℹ️ 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".

@plexoos plexoos force-pushed the remove-with-slog branch from 0b4c8f1 to 4623a36 Compare May 18, 2026 17:12
@plexoos plexoos changed the title refactor(core): remove legacy standalone and image-output paths refactor(core): remove legacy WITH_(SLOG|STTF) and image-output paths May 18, 2026
@plexoos plexoos merged commit be460aa into main May 18, 2026
23 of 24 checks passed
@plexoos plexoos deleted the remove-with-slog branch May 18, 2026 17:49
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants