Tutorials to write

[PProfizi]

This issue tracks PyDPF-Core issues related to adding examples for core functionalities.

Legend
🟡 From the examples section 🟡
🟣 From the user guide how-tos section 🟣
🟠 From the user guide DPF most used entities section 🟠

PyDPF-Core data structures

• DPF raw data storage structures
• DPF collections

PyDPF-Core language

• Basic dpf implementation (PyDPF-Core API use)

Post processing basics

• A basic PyDPF-Core script 🟡 A

Import data #1933

From user input

• Import data from csv file
• Manual input data on DPF

From result file

• Import a result file in DPF
• Extract results from a result file
• Extract and explore results metadata 🟡 C and E
• Extract and explore results data🟡C and E
• Narrow down data (scoping tutorial) 🟡 F and G

Mesh #1908

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

Transform data

• Using operators 🟡 B 🟠 I
• Create a workflow 🟠 I

Plot #1903

• Plotting meshes 🟡 N and O 🟠A
• Plotting data on the mesh 🟡 N and Q 🟠A
• Plotting data on the deformed mesh
• Plotting data on specific placements 🟡 P and S
• Plotting a graph

Animate #1915

• Animate data over time 🟡 R
• Animate data for modal analysis

Export data

• HDF5 export

Custom operators and plugins #1890

• Create custom operators and plugins 🟡 V and 🟣 B
• Create a plug-in package with multiple operators 🟡 W and 🟣B
• Create a plug-in package that has third-party dependencies 🟡 X

Post-process distributed files

• Post process data on distributed processes 🟡 T
• Create a custom workflow on distributed processes 🟡 U

DPF server #1891

Demander a antoine

• Switch between local and remote server 🟣 D

Licencing #1889

Demander a antoine

• Access Entry and Premium Capabilities 🟣 E

Mathematical operations #1910

• Basic maths

Manipulating physics data

• Unit, homogeneity

[PProfizi]

Hey @luisaFelixSalles , on the topic of an example for Field,
I think an example dedicated to mathematical operations on Fields would be good, as shown in the email from Ramdane.

It should show basic matrix operations, including combining different Fields into a single one with multiple components.

[luisaFelixSalles]

Hey @luisaFelixSalles , on the topic of an example for Field, I think an example dedicated to mathematical operations on Fields would be good, as shown in the email from Ramdane.

It should show basic matrix operations, including combining different Fields into a single one with multiple components.

Yes I agree. It's one of my suggestions on the #1694 on the "math operators" example.

[luisaFelixSalles]

Layout changes

• Use of grid instead of card carrousel (so we can always see the options in the cards)

[PProfizi]

Hey Luisa could we list the need for a tutorial on Units and homogeneity please.

[luisaFelixSalles]

Examples that should be tutorials

Legend
🟢 Yes 🟢
🔴 No 🔴

Basic

• 0.Basic DPF Core usage🟢 A
  I've already transformed it
• 1.Operators overview 🟢 B
• 2.Field and field containers overview 🟢 C
• 3.Create our own entities using dpf operators 🟢 D
• 5.Bring a fields data locally to improve performance 🔴
• 7.Use results helpers to load custom data 🟢 E
• 8.Scope results over custom time domains 🟢 F
• 9.Scope results over custom space domains 🟢 G
• 10.Mathematical Operators 🔴
• 11.Servers type ?
• 12.Get material properties from the result file 🔴

Transient Analysis examples

• 0.Transient analysis result example 🔴
• 1.Choose a time scoping for a transient analysis 🔴

Modal analysis examples

• 0.Use Result Helpers to compare mode shapes for solids and then shells 🔴
• 1.Plot and animate mode shapes with DPF 🔴

Harmonic analysis examples

• 0.Multi-harmonic response example 🔴
• 1.Expand harmonic modal superposition with DPF 🔴

Advanced and Miscellaneous examples

• 0.Multi-stage cyclic symmetry using advanced customization 🔴
• 1.Solve harmonic problem (with damping) using matrix inverse🔴
• 2.Average elemental stress on a given volume 🔴
• 3.Exchange data between servers 🟢H
• 4.Extrapolation method for stress result of a 3D element 🔴
• 5.Extrapolation method for strain result of a 2D element 🔴
• 6.Stress gradient normal to a defined node 🔴
• 7.Load plugin 🟢I
• 10.Pressure vessel analysis according to an ASME standard 🔴
• 11.Calculate the number of cycles to fatigue failure 🔴
• 12.Read results from distributed files 🟢 J
• 13.Manage the DPF licensing logic using the server context 🟢 K
• 14.Use incremental evaluation helper 🔴

File manipulation and input-output

• 0.HDF5 export and compare precision 🔴
• 1.Get reduced matrices and make export 🔴
• 2.HDF5 export and import operations 🟢 L
• 4.Working with a result file 🟢 M

Plotting examples

• 0.Review of available plotting commands 🟢 N
• 1.Compare results using the plotter 🔴
• 2.Load case combination for principal stress 🔴
• 3.Add nodal labels on plots 🟢O
• 4.Plot results on a specific path 🟢 P
• 5.Warp the mesh by a field for plotting 🟢 Q
• 6.Review of available animation commands 🟢R
• 7.Plot on geometry elements 🟢S

Examples for post-processing on distributed processes

• 0.Post-processing of displacement on distributed processes 🟢 T
• 1.Create a custom workflow on distributed processes 🟢U
• 2.Distributed mode superposition (MSUP) 🔴
• 3.Distributed MSUP distributed modal response 🔴
• 6.Distributed stress averaging 🔴

Examples of creating custom operator plugins

• 0.Create a basic operator plugin 🟢V
• 1.Create a plug-in package with multiple operators 🟢 W
• 2.Create a plug-in package that has third-party dependencies 🟢 X

Average examples

• 0.Averaging order 🔴
• 1.Average across bodies 🔴

Mesh operations examples

• 0.Create and display a mesh with polygon and polyhedron elements 🔴
• 5.Extract the skin from a mesh 🔴
• 13.Convert nodal coordinates field to local coordinate system 🟢 (if generalized for other locations) Y

Cyclic symmetry examples

• 0.Expand mesh and results for modal cyclic symmetry 🔴
• 1.Get base and duplicate sectors (real and imaginary) results for modal cyclic symmetry 🔴
• 2.Multi-stage cyclic symmetry example 🔴

Fluids examples

• 0.Explore Fluids models 🔴
• 1.Explore Fluids mesh 🔴
• 2.Explore Fluids results 🔴
• 3.Compute iso-surfaces on fluid model 🔴

Streamlines examples

• 0.Compute and plot 3D streamlines 🔴
• 1.Compute and plot 2D streamlines 🔴

LS-Dyna Examples

• 0.Results extraction and analysis from LS-Dyna sources 🔴

CFX examples

• 0.Read CFX .res files🔴

[luisaFelixSalles]

User guide parts that should be in the tutorials

Legend
🟢 Yes 🟢
🔴 No 🔴

How-tos

• 0.Plot🟢 A
• 1.Create custom operators 🟢 B
• 2.Use DPF server package 🟢 C
• 3.Switch between local and remote serve 🟢D
• 4.Access Entry and Premium Capabilities 🟢E
• 5.Use DPX XML files 🟢F

DPF most used entities

• 0.DPF model 🟢 G (Should be in the concepts but the info here could be used in a tutorial)
• 1.Field and field containers 🟢H (Should be in the concepts but the info here could be used in a tutorial)
• 2.Operatos 🟢I (Should be in the concepts but the info here could be used in a tutorial)

[PProfizi]

@luisaFelixSalles can we add in required tutorials a section or a tutorial for mathematical operations on Fields.
A bit like your example, but with more explanations regarding things such as *, +, -.

[luisaFelixSalles]

This issue tracks PyDPF-Core issues related to adding examples for core functionalities.

Legend
🟡 From the examples section 🟡
🟣 From the user guide how-tos section 🟣
🟠 From the user guide DPF most used entities section 🟠

PyDPF-Core data structures

• DPF raw data storage structures
  • get inspiration from field tut
• DPF collections
  • get inspiration from field tut

PyDPF-Core language

• Basic dpf implementation (PyDPF-Core API use)
  • adapt Add a new example 00-basic_dpf_implementation.py #1709

Post processing basics

• A basic PyDPF-Core script 🟡 A
  • done in my new tutorial section branch post processing main steps.
  • Inspired by (🟡 A ) the Basic DPF-Core usage example

Import data

From user input

• Import data from csv file
• Create a data storage structure from scratch
  • get inspiration from field tut

From result file

• Import a result file in DPF
• Extract and explore results metadata 🟡 C and E
  • get inspiration from field tut, from (🟡 C ) Field and field containers overview and from (🟡 E ) Use result helpers to load custom data examples
• Extract and explore results 🟡C and E
  • get inspiration from field tut, from (🟡 C ) Field and field containers overview and from (🟡 E ) Use result helpers to load custom data examples
• Narrow down data (scoping tutorial) 🟡 F and G
  • get inspiration from field tut, from (🟡 F ) Scope results over custom time domains and from (🟡 G ) Scope results over custom space domains examples

Mesh #1908

• Create a mesh from scratch 🟡 D
  • get inspiration from (🟡 D ) Create your own entities using DPF operators example
• Get a mesh from a result file
• Explore a mesh
• Read a mesh metadata
• Extract a mesh in split parts
• Split a mesh

Transform data

• Using operators 🟡 B 🟠 I
  • get inspiration from (🟡 B ) Operators overview example and from (🟠 I ) Operators
• Create a workflow 🟠 I
  • get inspiration from (🟠 I )Operators

Plot #1903

• Plotting meshes 🟡 N and O 🟠A
  • get inspiration from (🟡 N ) Review of available plotting commands, from (🟡 O ) Add nodal labels on plots and from (🟠A ) Plot
• Plotting data on the mesh 🟡 N and Q 🟠A
  • get inspiration from (🟡 N ) Review of available plotting commands example, from (🟡 Q ) Warp the mesh by a field for plotting example and from (🟠A ) Plot
• Plotting data on the deformed mesh
• Plotting data on specific placements 🟡 P and S
  • get inspiration from (🟡 P ) Plot results on a specific path and from (🟡 S ) Plot on geometry element examples
• Plotting a graph

Animate #1915

• Animate data over time 🟡 R
  • get inspiration from (🟡 R ) Review of available animation commands example
• Animate data for modal analysis

Export data

• HDF5 export

Custom operators and plugins #1890

• Create custom operators and plugins 🟡 V and 🟣 B
  • get inspiration from (🟡 V ) Create a basic operator plugin example and from (🟣 B ) Create custom operator
  • actually the (🟡 V ) example is a example. We just need to change its name like: "Create a operator that computes simple statistics quantities on a scalar field "
• Create a plug-in package with multiple operators 🟡 W and 🟣B
  • get inspiration from (🟡 W ) Create a plug-in package with multiple operators example and from (🟣 B ) Create custom operator
  • • actually the (🟡 W ) example is a example. We just need to change its name and some text maybe
• Create a plug-in package that has third-party dependencies 🟡 X
  • get inspiration from (🟡 X ) Create a plug-in package that has third-party dependencies example

Post-process distributed files

• Post process data on distributed processes 🟡 T
  • get inspiration from (🟡 T ) Post-processing of displacement on distributed processes example
• Create a custom workflow on distributed processes 🟡 U
  • get inspiration from (🟡 U ) Create a custom workflow on distributed processes example

DPF server #1891

• Switch between local and remote server 🟣 D
  • get inspiration from (🟣 D ) Switch between local and remote serve

Licencing #1889

• Access Entry and Premium Capabilities 🟣 E
  • get inspiration from (🟣 E ) Access Entry and Premium Capabilities

Mathematical operations #1910

• Basic maths

Manipulating physics data

• Unit, homogeneity