Skip to content

feat: add TBPL command to PLOT_COMMANDS list - #4119

Merged
germa89 merged 2 commits into
mainfrom
feat/adding-tbplot-to-plot-commands
Jul 23, 2025
Merged

feat: add TBPL command to PLOT_COMMANDS list#4119
germa89 merged 2 commits into
mainfrom
feat/adding-tbplot-to-plot-commands

Conversation

@germa89

@germa89 germa89 commented Jul 22, 2025

Copy link
Copy Markdown
Collaborator

Description

Allow showing the plot when using mapdl.tbplot.

Issue linked

Close #1304

Checklist

Summary by Sourcery

New Features:

  • Enable mapdl.tbplot to show plots by including TBPL in the PLOT_COMMANDS list

Copilot AI review requested due to automatic review settings July 22, 2025 15:00
@germa89
germa89 requested a review from a team as a code owner July 22, 2025 15:00
@germa89 germa89 self-assigned this Jul 22, 2025
@ansys-reviewer-bot

Copy link
Copy Markdown
Contributor

Thanks for opening a Pull Request. If you want to perform a review write a comment saying:

@ansys-reviewer-bot review

@sourcery-ai

sourcery-ai Bot commented Jul 22, 2025

Copy link
Copy Markdown
Contributor

Reviewer's Guide

Extend the internal PLOT_COMMANDS list to recognize and execute the new TBPL plot command, enabling mapdl.tbplot to display TBPL-based plots.

Class diagram for updated PLOT_COMMANDS list

classDiagram
    class mapdl_core {
        +PLOT_COMMANDS: List[str]
        +MAX_COMMAND_LENGTH: int
    }
    note for mapdl_core "PLOT_COMMANDS now includes 'TBPL' to support TBPL plot command."
Loading

File-Level Changes

Change Details Files
Include TBPL in recognized plot commands
  • Add 'TBPL' entry to the PLOT_COMMANDS constant list
src/ansys/mapdl/core/mapdl_core.py

Assessment against linked issues

Issue Objective Addressed Explanation
#1304 Implement plotting functionality for tbplot(), e.g., via pyvista or general_plotter(), so that mapdl.tbplot() produces a plot for material models. The PR only adds 'TBPL' to the PLOT_COMMANDS list, which may allow the command to be recognized as a plot command, but there is no implementation of actual plotting functionality for tbplot() or integration with pyvista/general_plotter. No code is added to generate a plot when mapdl.tbplot() is called.
#1304 Add a warning when calling tbplot() if plotting is not implemented. The PR does not add any warning or message when tbplot() is called. It only modifies a list of plot commands.
#1304 Update the doc-string for tbplot() to indicate the current (lack of) plotting support or warn users. There are no changes to documentation or doc-strings in the PR. The diff only shows a change to the PLOT_COMMANDS list.

Tips and commands

Interacting with Sourcery

  • Trigger a new review: Comment @sourcery-ai review on the pull request.
  • Continue discussions: Reply directly to Sourcery's review comments.
  • Generate a GitHub issue from a review comment: Ask Sourcery to create an
    issue from a review comment by replying to it. You can also reply to a
    review comment with @sourcery-ai issue to create an issue from it.
  • Generate a pull request title: Write @sourcery-ai anywhere in the pull
    request title to generate a title at any time. You can also comment
    @sourcery-ai title on the pull request to (re-)generate the title at any time.
  • Generate a pull request summary: Write @sourcery-ai summary anywhere in
    the pull request body to generate a PR summary at any time exactly where you
    want it. You can also comment @sourcery-ai summary on the pull request to
    (re-)generate the summary at any time.
  • Generate reviewer's guide: Comment @sourcery-ai guide on the pull
    request to (re-)generate the reviewer's guide at any time.
  • Resolve all Sourcery comments: Comment @sourcery-ai resolve on the
    pull request to resolve all Sourcery comments. Useful if you've already
    addressed all the comments and don't want to see them anymore.
  • Dismiss all Sourcery reviews: Comment @sourcery-ai dismiss on the pull
    request to dismiss all existing Sourcery reviews. Especially useful if you
    want to start fresh with a new review - don't forget to comment
    @sourcery-ai review to trigger a new review!

Customizing Your Experience

Access your dashboard to:

  • Enable or disable review features such as the Sourcery-generated pull request
    summary, the reviewer's guide, and others.
  • Change the review language.
  • Add, remove or edit custom review instructions.
  • Adjust other review settings.

Getting Help

Copilot AI 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.

Pull Request Overview

This PR adds support for showing plots when using the mapdl.tbplot command by adding "TBPL" to the PLOT_COMMANDS list. This is a simple enhancement to enable plot display functionality for the TBPL command.

  • Added "TBPL" to the PLOT_COMMANDS list to enable plot visualization for the tbplot method

@sourcery-ai sourcery-ai Bot 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.

Hey @germa89 - I've reviewed your changes and they look great!


Sourcery is free for open source - if you like our reviews please consider sharing them ✨
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.

@github-actions github-actions Bot added the new feature Request or proposal for a new feature label Jul 22, 2025
@codecov

codecov Bot commented Jul 22, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 91.19%. Comparing base (2168c7f) to head (c3b9f33).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #4119      +/-   ##
==========================================
- Coverage   91.23%   91.19%   -0.04%     
==========================================
  Files         189      189              
  Lines       15650    15650              
==========================================
- Hits        14278    14272       -6     
- Misses       1372     1378       +6     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@germa89

germa89 commented Jul 23, 2025

Copy link
Copy Markdown
Collaborator Author

@pyansys-ci-bot LGTM.

@germa89
germa89 enabled auto-merge (squash) July 23, 2025 06:36

@pyansys-ci-bot pyansys-ci-bot 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.

✅ Approving this PR because germa89 said so in here 😬

LGTM

@germa89
germa89 merged commit 870f746 into main Jul 23, 2025
81 of 83 checks passed
@germa89
germa89 deleted the feat/adding-tbplot-to-plot-commands branch July 23, 2025 06:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

new feature Request or proposal for a new feature

Projects

None yet

Development

Successfully merging this pull request may close these issues.

tbplot() not impelemented via pyvista

3 participants