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 custom Python operator and plugin tutorials #1890

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

Conversation

luisaFelixSalles
Copy link
Collaborator

@luisaFelixSalles luisaFelixSalles commented Nov 13, 2024

Closes #1869

Add new tutorials to the enriching dpf capabilities Custom Operators and Plugins section:

  • It adapts some "how-tos" into this section
  • It changes some examples names

Tutorials added:

  • Create custom operators and plugins
  • Create a plug-in package with multiple operators
  • Create a plug-in package that has third-party dependencies

Preview on how it renders:

Custom Operators and Plugins section main page

image

Create custom operators and plugins tutorial

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_custom_operators_and_plugins_custom_operators html

Create a plug-in package with multiple operators

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_custom_operators_and_plugins_custom_plug_in_package html

Create a plug-in package that has third-party dependencies

_D__ANSYSdev_pydpf-core_doc_build_html_user_guide_tutorials_custom_operators_and_plugins_custom_plug_in_package_third_deps html

@luisaFelixSalles luisaFelixSalles self-assigned this Nov 13, 2024
@luisaFelixSalles luisaFelixSalles changed the title Add enriching dpf capabilities tutorials Add enriching dpf capabilities tutorials to the main tutorials branch Nov 13, 2024
Copy link

codecov bot commented Nov 13, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 88.10%. Comparing base (97f32dc) to head (65ac1ab).

Additional details and impacted files
@@                      Coverage Diff                      @@
##           doc/new-tutorials-section    #1890      +/-   ##
=============================================================
+ Coverage                      88.02%   88.10%   +0.07%     
=============================================================
  Files                             83       83              
  Lines                           9963     9951      -12     
=============================================================
- Hits                            8770     8767       -3     
+ Misses                          1193     1184       -9     
---- 🚨 Try these New Features:

@PProfizi
Copy link
Contributor

Hey @luisaFelixSalles could we maybe do something more explicit than "enriching DPF capabilities"? I feel that we should have a section dedicated to "Custom Operators and Plugins".

@PProfizi
Copy link
Contributor

Also, to me this example 02-python_operators_with_dependencies.py should become a tutorial, no?

@PProfizi
Copy link
Contributor

PProfizi commented Nov 14, 2024

The tutorials section for Creating Custom DPF Operators and Plugins with Python should have a few tutorials:

  • Create a custom DPF plugin in Python
  • Create a custom DPF plugin in Python with third-party dependencies
  • Load and use a custom DPF plugin in PyDPF
  • Load and use a custom DPF plugin in Mechanical

@luisaFelixSalles
Copy link
Collaborator Author

Hey @luisaFelixSalles could we maybe do something more explicit than "enriching DPF capabilities"? I feel that we should have a section dedicated to "Custom Operators and Plugins".

yes i can change this name, not a problem

@luisaFelixSalles
Copy link
Collaborator Author

luisaFelixSalles commented Nov 15, 2024

The tutorials section for Creating Custom DPF Operators and Plugins with Python should have a few tutorials:

  • Create a custom DPF plugin in Python
  • Create a custom DPF plugin in Python with third-party dependencies
  • Load and use a custom DPF plugin in PyDPF
  • Load and use a custom DPF plugin in Mechanical

Yes, i'll put in the PR description the tutorials that this section has. Because I actually put the "load" explanations into each tutorial

@luisaFelixSalles luisaFelixSalles mentioned this pull request Nov 15, 2024
36 tasks
@PProfizi PProfizi added the tutorials Related to PyDPF-Core tutorials label Nov 19, 2024
@PProfizi PProfizi removed their request for review November 19, 2024 15:00
@PProfizi PProfizi changed the title Add enriching dpf capabilities tutorials to the main tutorials branch Add custom Python operator and plugin tutorials Nov 19, 2024
@luisaFelixSalles luisaFelixSalles force-pushed the doc/new-tutorials-section branch from 576cd9f to 627c2de Compare December 19, 2024 16: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.

2 participants