spacetelescope / jwst

Python library for science observations from the James Webb Space Telescope
https://jwst-pipeline.readthedocs.io/en/latest/
Other
561 stars 167 forks source link

Report jwst software version in output log #8749

Closed stscijgbot-jp closed 2 weeks ago

stscijgbot-jp commented 3 weeks ago

Issue JP-3729 was created on JIRA by David Law:

For user support purposes, it would be helpful to report the version of the jwst pipeline software in use in the output log.  For consistency the best location may be the end of the log next to the existing report of the CRDS context used.

I can see arguments for both having this information at the start of the log (print it early before getting into details) and at the end (end of the log stays on screen for longer, while all of the other log info scrolls the start of the log offscreen instantly).  As such let's add to the end rather than changing existing behavior.

stscijgbot-jp commented 3 weeks ago

Comment by David Law on JIRA:

Related: Looks like the CRDS context is printed at the end of the log for detector1 and spec2, but not for spec3?

stscijgbot-jp commented 3 weeks ago

Comment by Nadia Dencheva on JIRA:

Just a guess - that's because spec3 does not use any reference files. However, now that it uses par files we should print it. We'll check all pipelines/steps.

stscijgbot-jp commented 3 weeks ago

Comment by Brett Graham on JIRA:

David Law would you paste an example of the crds context log message? Is it something like "Results used CRDS context: ..."?

stscijgbot-jp commented 3 weeks ago

Comment by David Law on JIRA:

2024-09-06 11:13:11,410 - stpipe.Detector1Pipeline - INFO - Results used CRDS context: jwst_1276.pmap

stscijgbot-jp commented 3 weeks ago

Comment by Brett Graham on JIRA:

Re-opening as PR with the feature is going to be reverted due to a bug in stpipe that calls Step.finalize_result for every character in the input filename for skipped steps. spacetelescope/stpipe#188 A different approach will be needed.

braingram commented 2 weeks ago

New PR using working around the stpipe bug was merged: https://github.com/spacetelescope/jwst/pull/8769

stscijgbot-jp commented 1 week ago

Comment by David Law on JIRA:

With the 1.16.0 tag I'm now seeing

2024-09-20 17:54:50,081 - stpipe - INFO - Results used jwst version: 1.16.0

Looks good, closing!