Skip to content

Add method comparison plot docs using pair_plot - #223

Merged
jthorton merged 3 commits into
mainfrom
pair-plot-docs
Jun 17, 2026
Merged

Add method comparison plot docs using pair_plot#223
jthorton merged 3 commits into
mainfrom
pair-plot-docs

Conversation

@jthorton

Copy link
Copy Markdown
Contributor

Description

Provide a brief description of the PR's purpose here.
Fixes #220 by extending the plotting docs to include examples using pair_plot.

Todos

Notable points that this PR has either accomplished or will accomplish.

  • TODO 1

Questions

  • Question1

Checklist

  • Added a news entry for new features, bug fixes, or other user facing changes.

Status

  • Ready to go

Tips

  • Comment "pre-commit.ci autofix" to have pre-commit.ci atomically format your PR.
    Since this will create a commit, it is best to make this comment when you are finished with your work.

@review-notebook-app

Copy link
Copy Markdown

Check out this pull request on  ReviewNB

See visual diffs & provide feedback on Jupyter Notebooks.


Powered by ReviewNB

@jthorton

Copy link
Copy Markdown
Contributor Author

pre-commit.ci autofix

@codecov

codecov Bot commented Jun 12, 2026

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 97.53%. Comparing base (7a5d72f) to head (83abfa2).

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #223   +/-   ##
=======================================
  Coverage   97.53%   97.53%           
=======================================
  Files          22       22           
  Lines        2470     2470           
=======================================
  Hits         2409     2409           
  Misses         61       61           

☔ View full report in Codecov by Harness.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@review-notebook-app

review-notebook-app Bot commented Jun 15, 2026

Copy link
Copy Markdown

View / edit / reply to this conversation on ReviewNB

hannahbaumann commented on 2026-06-15T11:16:41Z
----------------------------------------------------------------

The three high-level plotting functions above make it easy to compare computaional results with experimental reference data within an FEMap. When you want to compare two computational results on the same target however you will need the low-level pair_plot function. This function provides the default cinnabar styling used by the high-level scatter plots but works with data as numpy arrays and offers more flexibility.

I wonder if the high-level/low-level distinction is necessary here or if it may be confusing to some users, maybe a slight re-wording could help to put the difference of the inputs more into focus (other functions used FEMap directly, here we work with the numpy arrays directly)?


jthorton commented on 2026-06-17T10:14:33Z
----------------------------------------------------------------

Updated to remove the high/low-level text and concentrate on the API differences.

@review-notebook-app

review-notebook-app Bot commented Jun 15, 2026

Copy link
Copy Markdown

View / edit / reply to this conversation on ReviewNB

hannahbaumann commented on 2026-06-15T11:16:42Z
----------------------------------------------------------------

Line #2.    femap_to_methods = FEMap()

Was this meant to be femap_two_methods?


jthorton commented on 2026-06-16T10:56:27Z
----------------------------------------------------------------

Ah yeah thanks, fixed!

@review-notebook-app

review-notebook-app Bot commented Jun 15, 2026

Copy link
Copy Markdown

View / edit / reply to this conversation on ReviewNB

hannahbaumann commented on 2026-06-15T11:16:43Z
----------------------------------------------------------------

Line #5.    # and add a second copy with ranom noise added to the values to simulate a second method

"random"


jthorton commented on 2026-06-16T10:55:54Z
----------------------------------------------------------------

Fixed

@review-notebook-app

review-notebook-app Bot commented Jun 15, 2026

Copy link
Copy Markdown

View / edit / reply to this conversation on ReviewNB

hannahbaumann commented on 2026-06-15T11:16:44Z
----------------------------------------------------------------

"preparation"


jthorton commented on 2026-06-16T10:56:00Z
----------------------------------------------------------------

Fixed.

@jthorton jthorton self-assigned this Jun 15, 2026

Copy link
Copy Markdown
Contributor Author

Fixed


View entire conversation on ReviewNB

Copy link
Copy Markdown
Contributor Author

Fixed.


View entire conversation on ReviewNB

Copy link
Copy Markdown
Contributor Author

Ah yeah thanks!


View entire conversation on ReviewNB

@jthorton
jthorton requested a review from hannahbaumann June 16, 2026 11:25

Copy link
Copy Markdown
Contributor Author

Updated to remove the high/low-level text and concentrate on the API differences.


View entire conversation on ReviewNB

@hannahbaumann hannahbaumann left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Thanks @jthorton , lgtm!

@jthorton
jthorton merged commit cfe3d74 into main Jun 17, 2026
8 checks passed
@jthorton
jthorton deleted the pair-plot-docs branch June 17, 2026 12:38
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.

Add docs for method comparisons using pair_plot

2 participants