Skip to content

FEAT: populate named expressions and improve doc - #6027

Merged
Samuelopez-ansys merged 33 commits into
mainfrom
feat/named_expressions_template
Apr 21, 2025
Merged

FEAT: populate named expressions and improve doc#6027
Samuelopez-ansys merged 33 commits into
mainfrom
feat/named_expressions_template

Conversation

@gmalinve

@gmalinve gmalinve commented Apr 9, 2025

Copy link
Copy Markdown
Contributor

Description

In this PR I added a way to retrieve all named expressions from the fields calculator and improve the doc for both points cloud and fields distribution extensions.

Issue linked

Please mention the issue number or describe the problem this pull request addresses.

Checklist

  • I have tested my changes locally.
  • I have added necessary documentation or updated existing documentation.
  • I have followed the coding style guidelines of this project.
  • I have added appropriate tests (unit, integration, system).
  • I have reviewed my changes before submitting this pull request.
  • I have linked the issue or issues that are solved by the PR if any.
  • I have agreed with the Contributor License Agreement (CLA).

@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

@github-actions github-actions Bot added the enhancement New features or code improvements label Apr 9, 2025
@gmalinve gmalinve changed the title named expressions template FEAT: populate named expressions Apr 14, 2025
@gmalinve gmalinve self-assigned this Apr 15, 2025
@gmalinve
gmalinve marked this pull request as ready for review April 15, 2025 12:54
@gmalinve
gmalinve requested a review from nunesanderson April 15, 2025 13:08
@gmalinve gmalinve changed the title FEAT: populate named expressions FEAT: populate named expressions and improve doc Apr 15, 2025
@gmalinve
gmalinve requested a review from anur7 April 15, 2025 13:11
@codecov

codecov Bot commented Apr 15, 2025

Copy link
Copy Markdown

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 85.14%. Comparing base (029d25d) to head (5dfbad1).
Report is 1 commits behind head on main.

Additional details and impacted files
@@            Coverage Diff             @@
##             main    #6027      +/-   ##
==========================================
- Coverage   85.14%   85.14%   -0.01%     
==========================================
  Files         167      167              
  Lines       63041    63041              
==========================================
- Hits        53675    53674       -1     
- Misses       9366     9367       +1     
🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

Comment thread doc/source/User_guide/pyaedt_extensions_doc/maxwell/fields_distribution.rst Outdated
Comment thread doc/source/User_guide/pyaedt_extensions_doc/maxwell/fields_distribution.rst Outdated
Comment thread doc/source/User_guide/pyaedt_extensions_doc/project/points_cloud_generator.rst Outdated
Comment thread doc/source/User_guide/pyaedt_extensions_doc/project/points_cloud_generator.rst Outdated
Comment thread doc/source/User_guide/pyaedt_extensions_doc/project/points_cloud_generator.rst Outdated

@SMoraisAnsys SMoraisAnsys left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

I didn't test the extension changes locally but I checked the documentation. I left some minor comments.
Can you clarify whether you should use "points cloud" or "point cloud" ? Both are used and I think only one of them should be.

Comment thread doc/source/User_guide/pyaedt_extensions_doc/maxwell/fields_distribution.rst Outdated
Comment thread doc/source/User_guide/pyaedt_extensions_doc/maxwell/fields_distribution.rst Outdated
Comment thread doc/source/User_guide/pyaedt_extensions_doc/maxwell/fields_distribution.rst Outdated
Comment thread doc/source/User_guide/pyaedt_extensions_doc/maxwell/fields_distribution.rst Outdated
Comment thread doc/source/User_guide/pyaedt_extensions_doc/maxwell/fields_distribution.rst Outdated
Comment thread doc/source/User_guide/pyaedt_extensions_doc/maxwell/fields_distribution.rst Outdated
Comment thread doc/source/User_guide/pyaedt_extensions_doc/maxwell/fields_distribution.rst Outdated
Comment thread doc/source/User_guide/pyaedt_extensions_doc/project/points_cloud_generator.rst Outdated
Comment thread doc/source/User_guide/pyaedt_extensions_doc/project/points_cloud_generator.rst Outdated
Comment thread doc/source/User_guide/pyaedt_extensions_doc/project/points_cloud_generator.rst Outdated

@SMoraisAnsys SMoraisAnsys left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Just wondering, would it make sense to also use "PTS" instead of ".pts" in the extension UI ? If yes, please have a look at fields_distribution.py L341

Comment thread doc/source/User_guide/pyaedt_extensions_doc/project/point_cloud_generator.rst Outdated
Comment thread doc/source/User_guide/pyaedt_extensions_doc/project/point_cloud_generator.rst Outdated
Co-authored-by: Sébastien Morais <146729917+SMoraisAnsys@users.noreply.github.com>
@gmalinve

Copy link
Copy Markdown
Contributor Author

@SMoraisAnsys thanks for your comments.
Regarding the format I'll keep it as is in the UI. For example this is what is shown in AEDT UI:
image

@Samuelopez-ansys Samuelopez-ansys left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

LGTM

@Samuelopez-ansys
Samuelopez-ansys merged commit 2ef8f4a into main Apr 21, 2025
@Samuelopez-ansys
Samuelopez-ansys deleted the feat/named_expressions_template branch April 21, 2025 09:26
nunesanderson pushed a commit that referenced this pull request Apr 30, 2025
Co-authored-by: pyansys-ci-bot <92810346+pyansys-ci-bot@users.noreply.github.com>
Co-authored-by: Sébastien Morais <146729917+SMoraisAnsys@users.noreply.github.com>
Co-authored-by: Samuelopez-ansys <samuel.lopez@ansys.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

enhancement New features or code improvements

Projects

None yet

Development

Successfully merging this pull request may close these issues.

add fields calculator named expressions template Improve extensions documentation

5 participants