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

Add math tutorials to the main tutorials branch #1910

Open
wants to merge 11 commits into
base: doc/new-tutorials-section
Choose a base branch
from

Conversation

luisaFelixSalles
Copy link
Collaborator

@luisaFelixSalles luisaFelixSalles commented Nov 19, 2024

Adds the tutorials of the math section

List of tutorials:

  • Basic maths

Preview on how it renders:

Mathematics section main page

image

Basic maths

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_mathematics_basic_maths html (1)

@luisaFelixSalles luisaFelixSalles self-assigned this Nov 19, 2024
@luisaFelixSalles luisaFelixSalles changed the base branch from master to doc/new-tutorials-section November 19, 2024 14:06
@PProfizi
Copy link
Contributor

@luisaFelixSalles can we scroll down in the out section here?
image
If not then some prints are missing

@PProfizi
Copy link
Contributor

It seems there mismatches between code and output
image

How come?

@luisaFelixSalles luisaFelixSalles mentioned this pull request Nov 19, 2024
36 tasks
Copy link

codecov bot commented Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.44%. Comparing base (627c2de) to head (643c312).

Additional details and impacted files
@@                      Coverage Diff                      @@
##           doc/new-tutorials-section    #1910      +/-   ##
=============================================================
- Coverage                      88.50%   88.44%   -0.07%     
=============================================================
  Files                             89       89              
  Lines                          10251    10251              
=============================================================
- Hits                            9073     9066       -7     
- Misses                          1178     1185       +7     

Comment on lines 7 to 10
.. |Field| replace:: :class:`Field<ansys.dpf.core.field.Field>`
.. |Fields| replace:: :class:`Field<ansys.dpf.core.field.Field>`
.. |FieldsContainer| replace:: :class:`FieldsContainer<ansys.dpf.core.field.Field>`
.. |FieldsContainers| replace:: :class:`FieldsContainer<ansys.dpf.core.field.Field>`
Copy link
Contributor

Choose a reason for hiding this comment

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

@luisaFelixSalles is that something we could make common somewhere?

Copy link
Collaborator Author

Choose a reason for hiding this comment

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

Hm yes we can make it in a separate file and include it in the beginning of each tutorial. But then it would put references we don't use in some tutorials. Idk if that ok ?

@luisaFelixSalles
Copy link
Collaborator Author

luisaFelixSalles commented Nov 19, 2024

@luisaFelixSalles can we scroll down in the out section here? image If not then some prints are missing

Yes we can, I think is just not in the screenshot

@PProfizi PProfizi added the tutorials Related to PyDPF-Core tutorials label Nov 19, 2024
@luisaFelixSalles luisaFelixSalles force-pushed the tutorials/math/firsts-math-tutorials branch from ce9b1fc to cd37263 Compare November 20, 2024 12:41
@luisaFelixSalles luisaFelixSalles force-pushed the tutorials/math/firsts-math-tutorials branch from 4a1bf3b to 0b7935b Compare December 17, 2024 10:59
@luisaFelixSalles luisaFelixSalles force-pushed the doc/new-tutorials-section branch from 576cd9f to 627c2de Compare December 19, 2024 16:42
@luisaFelixSalles luisaFelixSalles force-pushed the tutorials/math/firsts-math-tutorials branch from 4606b6a to 939a805 Compare December 20, 2024 11:09

.. tab-item:: Fields

Create the Fields by defining:
Copy link
Member

Choose a reason for hiding this comment

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

Maybe use lowercase here or the |Field| option?

Suggested change
Create the Fields by defining:
Create the fields by defining:

- The entities ids and location. Thus, the |Field| scoping

- If not specified, the location is *'nodal'* by default.
- Each entity (here, the nodes) must have a |Scoping| id. The ids allows DPF to apply an operator on the
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
- Each entity (here, the nodes) must have a |Scoping| id. The ids allows DPF to apply an operator on the
- Each node must have a |Scoping| id. The ids allows DPF to apply an operator on the

# Import the math operators module
from ansys.dpf.core.operators import math as maths

Create the Fields by intanciating the |Field| object.
Copy link
Member

Choose a reason for hiding this comment

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

Suggested change
Create the Fields by intanciating the |Field| object.
Create the fields by intanciating the |Field| object.

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.

3 participants