Merge branch 'main' into refactor/typing_workflow_record

Author: PProfizi

.ci/code_generation.py

@@ -11,24 +11,36 @@
 core.set_default_server_context(core.AvailableServerContexts.premium)
 core.start_local_server(config=core.AvailableServerConfigs.LegacyGrpcServer)
 
+files_to_keep = {
+    "operator.mustache": "",
+    "build.py": "",
+    "specification.py": "",
+    "translator.py": "",
+    # Deprecated operator scripting names
+    "result": [
+        "gasket_deformation.py",
+        "gasket_deformation_X.py",
+        "gasket_deformation_XY.py",
+        "gasket_deformation_XZ.py",
+    ],
+}
+
 local_dir = Path(__file__).parent
 TARGET_PATH = local_dir.parent / "src" / "ansys" / "dpf" / "core" / "operators"
 files = TARGET_PATH.glob("*")
 for file_path in files:
-    if file_path.stem == "specification":
-        continue
-    if file_path.stem == "translator":
-        continue
-    if file_path.name == "build.py":
+    if file_path.is_file() and (file_path.name in files_to_keep):
         continue
-    if file_path.name == "operator.mustache":
-        continue
-    try:
-        if file_path.is_dir():
-            shutil.rmtree(file_path)
+    if file_path.is_dir():
+        shutil.rmtree(file_path / "__pycache__", ignore_errors=True)
+        if file_path.name in files_to_keep:
+            sub_files = file_path.glob("*")
+            for sub_file in sub_files:
+                if sub_file.name not in files_to_keep[file_path.name]:
+                    sub_file.unlink()
         else:
-            file_path.unlink()
-    except:
-        pass
+            shutil.rmtree(file_path)
+    else:
+        file_path.unlink()
 
 build.build_operators()

.github/workflows/ci.yml

@@ -225,28 +225,23 @@ jobs:
     secrets: inherit
 
   tests-retro:
-    name: "Test DPF ${{ matrix.dpf.version }} compatibility"
+    name: "Test DPF ${{ matrix.version }} compatibility"
     if: |
       github.event.action != 'closed' &&
       (github.event.action != 'labeled' || github.event.label.name == 'deploy-pr-doc') &&
       (startsWith(github.head_ref, 'main') || github.event.action == 'ready_for_review' || !github.event.pull_request.draft)
     strategy:
       fail-fast: false
       matrix:
-        dpf:
-          - {"version": "252", "standalone-suffix": ""}
-          - {"version": "251", "standalone-suffix": ""}
-          - {"version": "242", "standalone-suffix": ""}
-          - {"version": "241", "standalone-suffix": ".sp01"}
-          - {"version": "232", "standalone-suffix": ""}
-          - {"version": "231", "standalone-suffix": ""}
-          - {"version": "222", "standalone-suffix": ""}
+        version:
+          - ${{ fromJson(vars.ANSYS_VERSIONS_RETRO) }}
+          - ${{ fromJson(vars.ANSYS_VERSION_LAST_RELEASED) }}
     uses: ./.github/workflows/tests.yml
     with:
-      ANSYS_VERSION: ${{ matrix.dpf.version }}
+      ANSYS_VERSION: ${{ matrix.version }}
       python_versions: '["3.10"]'
       DOCSTRING: false
-      standalone_suffix: ${{ matrix.dpf.standalone-suffix }}
+      standalone_suffix: ${{ matrix.version == '241' && '.sp01' || '' }}
     secrets: inherit
 
   sync-main-with-master:

.github/workflows/ci_release.yml

@@ -126,43 +126,40 @@ jobs:
     secrets: inherit
 
   tests-retro:
-    name: "Test DPF ${{ matrix.dpf.version }} compatibility"
+    name: "Test DPF ${{ matrix.version }} compatibility"
     strategy:
       fail-fast: false
       matrix:
-        dpf:
-          - {"version": "251", "standalone-suffix": ""}
-          - {"version": "242", "standalone-suffix": ""}
-          - {"version": "241", "standalone-suffix": ".sp01"}
-          - {"version": "232", "standalone-suffix": ""}
-          - {"version": "231", "standalone-suffix": ""}
-          - {"version": "222", "standalone-suffix": ""}
+        version:
+          - ${{ fromJson(vars.ANSYS_VERSIONS_RETRO) }}
     uses: ./.github/workflows/tests.yml
     with:
-      ANSYS_VERSION: ${{ matrix.dpf.version }}
+      ANSYS_VERSION: ${{ matrix.version }}
       python_versions: '["3.10"]'
       DOCSTRING: false
-      standalone_suffix: ${{ matrix.dpf.standalone-suffix }}
+      standalone_suffix: ${{ matrix.version == '241' && '.sp01' || '' }}
     secrets: inherit
 
   tests-pydpf-post:
-    name: "Test PyDPF-Post with ${{ matrix.dpf.version}}"
+    name: "Test PyDPF-Post with ${{ matrix.version}}"
     strategy:
       fail-fast: false
       matrix:
-        dpf:
-          - {"version": "252", "standalone-suffix": "${{ github.event.inputs.standalone_branch_suffix || '' }}", "test_docstrings": "true"}
-          - {"version": "251", "standalone-suffix": "", "test_docstrings": "false"}
-          - {"version": "242", "standalone-suffix": "", "test_docstrings": "false"}
-          - {"version": "241", "standalone-suffix": "", "test_docstrings": "false"}
-          - {"version": "232", "standalone-suffix": "", "test_docstrings": "false"}
-          - {"version": "231", "standalone-suffix": "", "test_docstrings": "false"}
-          - {"version": "222", "standalone-suffix": "", "test_docstrings": "false"}
+        version:
+          - ${{ fromJson(vars.ANSYS_VERSIONS_RETRO) }}
+        standalone_suffix:
+          - ""
+        test_docstrings:
+          - "false"
+        include:
+          - version: ${{ vars.ANSYS_VERSION_LAST_RELEASED }}
+            standalone_suffix: ${{ github.event.inputs.standalone_branch_suffix || '' }}
+            test_docstrings": "true"
     uses: ./.github/workflows/pydpf-post.yml
     with:
-      ANSYS_VERSION: ${{ matrix.dpf.version }}
-      standalone_suffix: ${{ matrix.dpf.standalone-suffix }}
-      test_docstrings: ${{ matrix.dpf.test_docstrings }}
+      ANSYS_VERSION: ${{ matrix.version }}
+      standalone_suffix: ${{ matrix.version == '241' && '.sp01' || matrix.standalone_suffix }}
+      test_docstrings: ${{ matrix.test_docstrings }}
     secrets: inherit
 
   docker_tests:

doc/source/getting_started/compatibility.rst

@@ -49,6 +49,11 @@ package should also be synchronized with the server version.
      - ``ansys.grpc.dpf`` Python module version
      - ``ansys.dpf.gatebin`` binaries Python module version
      - ``ansys.dpf.gate`` Python module version
+   * - 11.0 (Ansys 2026 R1 pre0)
+     - 0.14.0 and later
+     - None
+     - None
+     - None
    * - 10.0 (Ansys 2025 R2)
      - 0.13.8 and later
      - None

doc/source/operators_doc/operator-specifications/operator_doc_template.md

@@ -18,7 +18,8 @@ license: {{ scripting_info.license }}
 |-------|-------|------------------|-------------|
 {%- for input in inputs %}
 | {% if not input.optional %}<strong>Pin {{ input.pin_number }}</strong> <br><span style="background-color:#d93025; color:white; padding:2px 6px; border-radius:3px; font-size:0.75em;">Required</span>{% else %}<strong>Pin {{ input.pin_number }}</strong>{% endif %}|  {{ input.name }} |
-{%- for t in input.types -%}{% if "::" in t %}{{ t }}{% elif t == "int32" or t == "bool" or t == char or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector<int32>" or t == "vector<bool>" or t == "vector<char>" or t == "vector<double>" or t == "vector<string>" or t == "vector<float>" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ input.document | replace("\n", "<br>") }} |
+{%- for t in input.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap<int32,int32>" or t == "stream" or t == "vector<shared_ptr<any_collection>>" or t == "vector<shared_ptr<field>>" or t == "umap<string,shared_ptr<abstract_field_support>>" or t == "vector<shared_ptr<abstract_meshed_region>>" or t == "vector<shared_ptr<materials>>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector<shared_ptr<fields_container>>" or t == "vector<shared_ptr<data_tree>>" or t == "vector<shared_ptr<generic_data_container>>" or t == "vector<shared_ptr<time_freq_support>>" or t == "mesh_selection_manager" or t == "vector<shared_ptr<abstract_field_support>>" or t == "vector<shared_ptr<string_field>>" or t == "vector<shared_ptr<scopings_container>>" or t == "vector<shared_ptr<scoping>>" or t == "vector<shared_ptr<result_info>>" or t == "vector<shared_ptr<meshes_container>>"
+ %}{{ t }}{% elif t == "int32" or t == "bool" or t == char or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector<int32>" or t == "vector<bool>" or t == "vector<char>" or t == "vector<double>" or t == "vector<string>" or t == "vector<float>" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ input.document | replace("\n", "<br>") }} |
 {%- endfor %}
 
 ## Outputs
@@ -27,7 +28,7 @@ license: {{ scripting_info.license }}
 |-------|------|------------------|-------------|
 {%- for output in outputs %}
 |  **Pin {{ output.pin_number }}**| {{ output.name }} |
-{%- for t in output.types -%}{% if "::" in t %}{{ t }}{% elif t == "int32" or t == "bool" or t == char or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector<int32>" or t == "vector<bool>" or t == "vector<char>" or t == "vector<double>" or t == "vector<string>" or t == "vector<float>" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ output.document }} |
+{%- for t in output.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap<int32,int32>" or t == "stream" or t == "vector<shared_ptr<any_collection>>" or t == "vector<shared_ptr<field>>" or t == "umap<string,shared_ptr<abstract_field_support>>" or t == "vector<shared_ptr<abstract_meshed_region>>" or t == "vector<shared_ptr<materials>>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector<shared_ptr<fields_container>>" or t == "vector<shared_ptr<data_tree>>" or t == "vector<shared_ptr<generic_data_container>>" or t == "vector<shared_ptr<time_freq_support>>" or t == "mesh_selection_manager" or t == "vector<shared_ptr<abstract_field_support>>" or t == "vector<shared_ptr<string_field>>" or t == "vector<shared_ptr<scopings_container>>" or t == "vector<shared_ptr<scoping>>" or t == "vector<shared_ptr<result_info>>" or t == "vector<shared_ptr<meshes_container>>" %}{{ t }}{% elif t == "int32" or t == "bool" or t == char or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector<int32>" or t == "vector<bool>" or t == "vector<char>" or t == "vector<double>" or t == "vector<string>" or t == "vector<float>" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ output.document }} |
 {%- endfor %}
 
 ## Configurations
@@ -36,7 +37,7 @@ license: {{ scripting_info.license }}
 |-----|------|----------|-------------|
 {%- for configuration in configurations %}
 | **{{ configuration.name }}** |
-{%- for t in configuration.types -%}{% if "::" in t %}{{ t }}{% elif t == "int32" or t == "bool" or t == char or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector<int32>" or t == "vector<bool>" or t == "vector<char>" or t == "vector<double>" or t == "vector<string>" or t == "vector<float>" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ configuration.default_value }} | {{ configuration.document }} |
+{%- for t in configuration.types -%}{% if "::" in t or t == "materials_container" or t == "materials" or t == "binary_operation_enum" or t == "umap<int32,int32>" or t == "stream" or t == "vector<shared_ptr<any_collection>>" or t == "vector<shared_ptr<field>>" or t == "umap<string,shared_ptr<abstract_field_support>>" or t == "vector<shared_ptr<abstract_meshed_region>>" or t == "vector<shared_ptr<materials>>" or t == "ans_dispatch_holder" or t == "struct IAnsDispatch" or t == "abstract_field_support" or t == "vector<shared_ptr<fields_container>>" or t == "vector<shared_ptr<data_tree>>" or t == "vector<shared_ptr<generic_data_container>>" or t == "vector<shared_ptr<time_freq_support>>" or t == "mesh_selection_manager" or t == "vector<shared_ptr<abstract_field_support>>" or t == "vector<shared_ptr<string_field>>" or t == "vector<shared_ptr<scopings_container>>" or t == "vector<shared_ptr<scoping>>" or t == "vector<shared_ptr<result_info>>" or t == "vector<shared_ptr<meshes_container>>" %}{{ t }}{% elif t == "int32" or t == "bool" or t == char or t == "double" or t == "string" or t == "uint32" or t == "uint64" or t == "vector<int32>" or t == "vector<bool>" or t == "vector<char>" or t == "vector<double>" or t == "vector<string>" or t == "vector<float>" %}[`{{ t }}`](../../core-concepts/dpf-types.md#standard-types){% elif t.startswith("abstract_") %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("abstract_", "") | replace("_", "-") | replace (" ", "-") | lower}}){% else %}[`{{ t }}`](../../core-concepts/dpf-types.md#{{ t | replace("_", "-") | replace(" ", "-") | lower}}){% endif %}{% if not loop.last %}, {% endif %}{%- endfor %} | {{ configuration.default_value }} | {{ configuration.document }} |
 {%- endfor %}
 
 ## Scripting

doc/source/user_guide/tutorials/plot/index.rst

@@ -39,11 +39,19 @@ These tutorials demonstrate different ways one can visualize the data in plots u
 
        This tutorial shows how to plot graphs using matplotlib.
 
+    .. grid-item-card:: Plot mesh scopings
+       :link: ref_tutorials_plot_mesh_scopings
+       :link-type: ref
+       :text-align: center
+
+       This tutorial shows how to plot mesh scopings.
+
 .. toctree::
     :maxdepth: 2
     :hidden:
 
     plot_mesh.rst
     plot_deformed_mesh.rst
     plot_contour.rst
-    plot_a_graph.rst
+    plot_a_graph.rst
+    plot_mesh_scopings.rst