Set verbose logging explicitly in the example run script - #1229
Merged
jdebacker merged 1 commit intoSep 26, 2026
Merged
Conversation
Addresses PSLmodels#1108. The example script relied on the import-time default in ogcore.config for its log level, so it was not self-documenting about the diagnostics it emits. This calls set_logging_level(verbose=True) explicitly at the top, and adds a comment noting that with a distributed Client (num_workers > 1) the per-iteration steady-state and transition distances are logged on the Dask worker processes and do not stream to this console, so a serial run is needed to see the full per-iteration output. Routing Dask worker logs back to the client console is a larger change and left for a separate issue.
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## master #1229 +/- ##
=======================================
Coverage 75.17% 75.17%
=======================================
Files 24 24
Lines 6031 6031
=======================================
Hits 4534 4534
Misses 1497 1497
Flags with carried forward coverage won't be shown. Click here to find out more. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What this does
Addresses #1108. The example script relied on the import-time default in
ogcore.configfor its log level, so it was not self-documenting about the diagnostics it emits. This callsset_logging_level(verbose=True)explicitly at the top ofrun_ogcore_example.py.It also adds a comment about a caveat worth knowing: when the model is run with a distributed
Client(num_workers > 1, as the example does), the per-iteration steady-state root-finding distances and transition-path distance measures are logged on the Dask worker processes and do not stream back to the console running the example. Running serially shows the full per-iteration output.Scope
Routing the Dask worker logs back to the client console is a larger change and left for a separate issue; this PR just makes the example's verbosity explicit and documents the parallel-run caveat. See the triage note on #1108 for the full context (the
ogcorelogger is already auto-set to INFO on import in currentconfig.py).