Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Improve sankey logging. #13239

Merged
merged 1 commit into from Jan 21, 2019
Merged

Improve sankey logging. #13239

merged 1 commit into from Jan 21, 2019

Conversation

anntzer
Copy link
Contributor

@anntzer anntzer commented Jan 20, 2019

Running the sankey_rankine example with an info-level logger on emits a
bunch of logs of the form

The scaled sum of the inputs is 0.039204.
This may cause poor layout.
Consider changing the scale so that the scaled sum is approximately 1.0.

but they are clearly intended as such (some flows are just very small,
and they render fine). Remove that log.

There are also some logs of the form

The sum of the flows is nonzero (-0.002000).
Is the system not at steady state?

Improve them by including the patchlabel, so that one can more easily
figure out the potentially incorrect flow values (one now gets

The sum of the flows is nonzero (-0.002000; patchlabel='\n\nOpen\nheater'); is the system not at steady state?

) (as for the actual values in the example, I guess someone should check
the reference the data comes from).

PR Summary

PR Checklist

  • Has Pytest style unit tests
  • Code is Flake 8 compliant
  • New features are documented, with examples if plot related
  • Documentation is sphinx and numpydoc compliant
  • Added an entry to doc/users/next_whats_new/ if major new feature (follow instructions in README.rst there)
  • Documented in doc/api/api_changes.rst if API changed in a backward-incompatible way

Running the sankey_rankine example with an info-level logger on emits a
bunch of logs of the form

> The scaled sum of the inputs is 0.039204.
> This may cause poor layout.
> Consider changing the scale so that the scaled sum is approximately 1.0.

but they are clearly intended as such (some flows are just very small,
and they render fine).  Remove that log.

There are also some logs of the form

> The sum of the flows is nonzero (-0.002000).
> Is the system not at steady state?

Improve them by including the patchlabel, so that one can more easily
figure out the potentially incorrect flow values (one now gets

> The sum of the flows is nonzero (-0.002000; patchlabel='\n\nOpen\nheater'); is the system not at steady state?

) (as for the actual values in the example, I guess someone should check
the reference the data comes from).
@jklymak jklymak merged commit d44d567 into matplotlib:master Jan 21, 2019
@anntzer anntzer deleted the sankey-log branch January 21, 2019 16:59
@QuLogic QuLogic added this to the v3.1 milestone Jan 21, 2019
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.

None yet

4 participants