Refactor and update the examples to clarify Entry and Premium capabilities (#674)

* New "file-IO" and "mesh_operations" sections

* Move examples in other sections

* Create a skin_extraction example

* Separate skin_extraction and use_local_data

* Make basic-plotting entry

* Refactor sections

* Reformat descriptions

* Reformat description and apply premium for the end of the example

* Fix ref to _user_guide_server_context in Note for Premium examples

* Fix folder name in run_non_regression_examples.py

* Fix link to Server context doc section

Author: PProfizi

.ci/run_non_regression_examples.py

@@ -14,7 +14,7 @@
 
 list_tests = [
     os.path.join(actual_path, os.path.pardir, "examples", "00-basic"),
-    os.path.join(actual_path, os.path.pardir, "examples", "01-static-transient"),
+    os.path.join(actual_path, os.path.pardir, "examples", "01-transient_analyses"),
     os.path.join(actual_path, os.path.pardir, "examples", "02-modal-harmonic"),
     os.path.join(actual_path, os.path.pardir, "examples", "05-plotting", "00-basic_plotting.py"),
     os.path.join(actual_path, os.path.pardir, "examples", "05-plotting",

examples/00-basic/00-basic_example.py

@@ -4,19 +4,17 @@
 
 Basic DPF-Core usage
 ~~~~~~~~~~~~~~~~~~~~
+
 This example shows how to open a result file and do some
 basic postprocessing.
 
 If you have Ansys 2021 R1 or higher installed, starting DPF is quite easy
 as DPF-Core takes care of launching all the services that
 are required for postprocessing Ansys files.
 
-First, import the DPF-Core module as ``dpf`` and import the
-included examples file.
-
-
 """
 
+# First, import the DPF-Core module as ``dpf`` and import the included examples file.
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples
 

examples/00-basic/01-basic_operators.py

@@ -15,9 +15,9 @@
 This example demonstrates how to work directly with operators and
 compares this method to a wrapped approach.
 
-Import the necessary modules:
 """
 
+# Import the necessary modules
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples
 

examples/00-basic/02-basic_field_containers.py

@@ -4,6 +4,7 @@
 
 Field and field containers overview
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 In DPF, the field is the main simulation data container. During a numerical
 simulation, the result data is defined by values associated to entities
 (scoping). These entities are a subset of a model (support).
@@ -29,9 +30,9 @@
 container have each individual field operated on. Fields
 containers are outputs from operators.
 
-First, import necessary modules:
-
 """
+
+# First, import necessary modules
 import numpy as np
 
 from ansys.dpf import core as dpf

examples/00-basic/03-create_entities.py

@@ -4,13 +4,15 @@
 
 Create your own entities using DPF operators
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 You can create your field, fields container, or meshed region to use DPF operators
 with your own data. The ability to use scripting to create any DPF entity means
 that you are not dependent on result files and can connect the DPF environment
 with any Python tool.
 
-Import necessary modules:
 """
+
+# Import necessary modules
 import numpy as np
 
 from ansys.dpf import core as dpf

examples/00-basic/05-use_local_data.py

@@ -3,52 +3,37 @@
 
 Bring a field's data locally to improve performance
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 Reducing the number of calls to the server is key to improving
 performance. Using the ``as_local_field`` option brings the data
 from the server to your local machine where you can work on it.
 When finished, you send the updated data back to the server
 in one transaction.
 
-.. note::
-    This example requires the Premium ServerContext.
-    For more information, see :ref:`_ref_getting_started_contexts`.
-
 """
+
 # Import necessary modules
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples
 from ansys.dpf.core import operators as ops
 
 
-dpf.set_default_server_context(dpf.AvailableServerContexts.premium)
-
 ###############################################################################
 # Create a model object to establish a connection with an
 # example result file and then extract:
 model = dpf.Model(examples.download_multi_stage_cyclic_result())
 print(model)
+mesh = model.metadata.meshed_region
 
 ###############################################################################
 # Create the workflow
 # ~~~~~~~~~~~~~~~~~~~~
-# Maximum principal stress usually occurs on the skin of the
-# model. Computing results only on this skin reduces the data size.
-
-# Create a simple workflow computing the principal stress on the skin
-# of the model.
-
-skin_op = ops.mesh.external_layer(model.metadata.meshed_region)
-skin_mesh = skin_op.outputs.mesh()
-
-###############################################################################
-# Plot the mesh skin:
-skin_mesh.plot()
 
 ###############################################################################
-# Compute the stress principal invariants on the skin nodes only:
+# Compute the stress principal invariants:
 stress_op = ops.result.stress(data_sources=model.metadata.data_sources)
 stress_op.inputs.requested_location.connect(dpf.locations.nodal)
-stress_op.inputs.mesh_scoping.connect(skin_op.outputs.nodes_mesh_scoping)
+stress_op.inputs.mesh_scoping.connect(mesh.nodes.scoping)
 
 principal_op = ops.invariant.principal_invariants_fc(stress_op)
 principal_stress_1 = principal_op.outputs.fields_eig_1()[0]
@@ -91,16 +76,16 @@
 
 ###############################################################################
 # Plot the result field on the skin mesh:
-skin_mesh.plot(field_to_keep)
+mesh.plot(field_to_keep)
 
 ###############################################################################
 # Plot initial invariants
 # ~~~~~~~~~~~~~~~~~~~~~~~
 
 
 ###############################################################################
-# Plot the initial invariants on the skin mesh:
+# Plot the initial invariants:
 
-skin_mesh.plot(principal_stress_1)
-skin_mesh.plot(principal_stress_2)
-skin_mesh.plot(principal_stress_3)
+mesh.plot(principal_stress_1)
+mesh.plot(principal_stress_2)
+mesh.plot(principal_stress_3)

examples/00-basic/07-use_result_helpers.py

@@ -4,15 +4,16 @@
 
 Use result helpers to load custom data
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 The :class:`Result <ansys.dpf.core.results.Result>` class, which is an instance
 created by the :class:`Model <ansys.dpf.core.model.Model>`, gives
 access to helpers for requesting results on specific mesh and time scopings.
 With these helpers, working on a custom spatial and temporal subset of the
 model is straightforward.
 
-Import necessary modules:
 """
 
+# Import necessary modules
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples
 

examples/00-basic/08-results_over_time_subset.py

@@ -4,16 +4,17 @@
 
 Scope results over custom time domains
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 The :class:`Result <ansys.dpf.core.results.Result>` class, which are instances
 created by the :class:`Model <ansys.dpf.core.model.Model>`, give
 access to helpers for requesting results on specific mesh and time scopings.
 With these helpers, working on a temporal subset of the
 model is straightforward. In this example, different ways to choose the temporal subset to
 evaluate a result are exposed. This example can be extended to frequency subsets.
 
-Import necessary modules:
 """
 
+# Import necessary modules
 from ansys.dpf import core as dpf
 from ansys.dpf.core import examples
 

examples/00-basic/09-results_over_space_subset.py

@@ -4,6 +4,7 @@
 
 Scope results over custom space domains
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 The :class:`Result <ansys.dpf.core.results.Result>` class, which are instances
 created by the :class:`Model <ansys.dpf.core.model.Model>`, give
 access to helpers for requesting results on specific mesh and time scopings.

examples/00-basic/11-server_types.py

@@ -4,6 +4,7 @@
 
 Communicate in process or via gRPC
 ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
 Starting with Ansys 2022 R2, PyDPF can communicate either via In Process or via gRPC
 with DPF C++ core server (``Ans.Dpf.Grpc.exe``). To choose which type of
 :class:`ansys.dpf.core.server_types.BaseServer` (object defining the type of communication