Skip to content

Add mesh tutorials to the main tutorials branch #1908

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

Merged

Conversation

luisaFelixSalles
Copy link
Contributor

@luisaFelixSalles luisaFelixSalles commented Nov 18, 2024

Add new plot tutorials to the mesh section:

List of tutorials:

  • Create a mesh from scratch
  • Get a mesh from a result file
  • Read a mesh metadata
  • Explore a mesh
  • Extract a mesh in split parts
  • Split a mesh

Preview on how it renders:

Mesh section main page

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_mesh_index html

Create a mesh from scratch

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_mesh_create_a_mesh_from_scratch html (2)

Get a mesh from a result file

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_mesh_get_mesh_from_result_file html (6)

Read a mesh metadata

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_mesh_read_mesh_metadata html (2)

Explore a mesh

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_mesh_explore_mesh html (1)

Extract a mesh in split parts

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_mesh_extract_mesh_in_split_parts html

Split a mesh

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_mesh_split_mesh html (3)

@luisaFelixSalles luisaFelixSalles self-assigned this Nov 18, 2024
@luisaFelixSalles luisaFelixSalles changed the base branch from master to doc/new-tutorials-section November 18, 2024 16:28
@luisaFelixSalles luisaFelixSalles mentioned this pull request Nov 18, 2024
36 tasks
Copy link

codecov bot commented Nov 18, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 47.94%. Comparing base (627c2de) to head (48a21a3).
Report is 145 commits behind head on doc/new-tutorials-section.

✅ All tests successful. No failed tests found.

Additional details and impacted files
@@                      Coverage Diff                       @@
##           doc/new-tutorials-section    #1908       +/-   ##
==============================================================
- Coverage                      88.50%   47.94%   -40.57%     
==============================================================
  Files                             89       90        +1     
  Lines                          10251    10308       +57     
==============================================================
- Hits                            9073     4942     -4131     
- Misses                          1178     5366     +4188     

@PProfizi
Copy link
Contributor

Could we restrict the mesh from scratch tutorial to just that? I think the add data and plot data sections should appear somewhere else. Also, this is not "adding" data to the mesh but rather creating data from scratch which we then plot on the mesh. I think this is covered in the plotting tutorials, and the data part should probably be in a tutorial on creating Fields and FieldsContainers from scratch which we can add separately.

@PProfizi
Copy link
Contributor

Get a mesh from a result file: problem with rendering for the mesh_provider operator reference in the section title.
Also we should add a section regarding the meshes_provider.

@PProfizi
Copy link
Contributor

Read and get specific information from a mesh:
rename to read mesh metadata.
I see several references not rendering properly.
Also this looks like two examples where put one after the other, could we rather merge them into one, while giving indications on specifics for different solvers?

@PProfizi
Copy link
Contributor

Get a mesh split on different parts: I think we reshape the tutorial to something very small explaining how to get a mesh split by body for each solver (Fluent+CFX or LSDYNA) with the mesh_provider/meshes_provider (explain the region_scoping input pin)

Basically here the idea would be to show how to Extract a mesh as split per body

The next tutorial on Split a mesh can then be focused on splitting on already existing MeshedRegion into a MeshesContainer, based on mesh properties. There is the split_mesh operator, but there is also the two-steps way using scoping.split_on_property_type and then mesh.from_scoping(s)

@luisaFelixSalles
Copy link
Contributor Author

Get a mesh from a result file: problem with rendering for the mesh_provider operator reference in the section title. Also we should add a section regarding the meshes_provider.

Wouldn't this section be the Extract a mesh as split per body tutorial?

@PProfizi PProfizi added the tutorials Related to PyDPF-Core tutorials label Nov 19, 2024
@luisaFelixSalles luisaFelixSalles force-pushed the tutorials/mesh/firsts-mesh-tutorials branch from 12622e2 to 4f2323d Compare November 20, 2024 12:38
@luisaFelixSalles luisaFelixSalles requested a review from a team as a code owner December 3, 2024 15:06
@luisaFelixSalles luisaFelixSalles force-pushed the tutorials/mesh/firsts-mesh-tutorials branch 2 times, most recently from bd42cc2 to 47afb3b Compare December 4, 2024 15:55
@luisaFelixSalles luisaFelixSalles force-pushed the doc/new-tutorials-section branch from 576cd9f to 627c2de Compare December 19, 2024 16:42
PProfizi and others added 2 commits May 13, 2025 14:58

Unverified

This commit is not signed, but one or more authors requires that any commit attributed to them is signed.
Co-authored-by: Muhammed Adedigba <[email protected]>

Verified

This commit was created on GitHub.com and signed with GitHub’s verified signature. The key has expired.
Co-authored-by: Jorge Martínez <[email protected]>
PProfizi and others added 2 commits May 13, 2025 15:07
Co-authored-by: Jorge Martínez <[email protected]>
PProfizi and others added 4 commits May 13, 2025 15:08
Co-authored-by: Jorge Martínez <[email protected]>
Co-authored-by: Jorge Martínez <[email protected]>
Fix typo
Co-authored-by: Camille Bellot <[email protected]>
Co-authored-by: Camille Bellot <[email protected]>
@PProfizi PProfizi self-requested a review May 13, 2025 13:18
Copy link
Contributor

@PProfizi PProfizi left a comment

Choose a reason for hiding this comment

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

Took all comments into consideration. Thanks everyone!

@PProfizi PProfizi merged commit 31d7034 into doc/new-tutorials-section May 14, 2025
1 check passed
@PProfizi PProfizi deleted the tutorials/mesh/firsts-mesh-tutorials branch May 14, 2025 12:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
tutorials Related to PyDPF-Core tutorials
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants