Merge branch 'main' into dependabot/pip/requirements/pytest-rerunfailures-16.1

Author: PProfizi

.github/workflows/ci.yml

@@ -206,39 +206,3 @@ jobs:
       DOCSTRING: false
       standalone_suffix: ${{ matrix.version == '241' && '.sp01' || '' }}
     secrets: inherit
-
-  sync-main-with-master:
-    name: "Sync main with master"
-    if: ${{ github.event_name == 'push' && github.ref == 'refs/heads/main' }}
-    runs-on: ubuntu-latest
-    steps:
-      - name: "Install Git and clone project"
-        uses: actions/checkout@11bd71901bbe5b1630ceea73d27597364c9af683 # v4.2.2
-        with:
-          token: ${{ secrets.MIGRATION_PAT }}
-          fetch-depth: 0
-
-      - name: "Verify that main is the default branch"
-        shell: bash
-        run: |
-          head_branch=$(git remote show origin | grep "HEAD branch:")
-          main_branch=${head_branch#*: }
-          
-          if [[ $main_branch != "main" ]]; then
-            echo "The default branch is not 'main'. It is set to '$main_branch'."
-            echo "Please set 'main' as the default branch in the repository settings."
-            exit 1
-          fi
-
-      - name: "Configure git username and email"
-        shell: bash
-        run: |
-          git config --global user.name "${{ secrets.PYANSYS_CI_BOT_USERNAME }}"
-          git config --global user.email "${{ secrets.PYANSYS_CI_BOT_EMAIL }}"
-
-      - name: "Sync main to master"
-        shell: bash
-        run: |
-          git checkout master
-          git reset --hard main
-          git push

.github/workflows/docs.yml

@@ -79,7 +79,7 @@ jobs:
       - name: "Build the wheel"
         shell: pwsh
         run: |
-          tox -e build-wheel
+          tox -e build-wheel -- "any"
 
       - name: "Expose the wheel"
         shell: bash

doc/source/_static/dpf_operators.html

@@ -5,7 +5,7 @@ requires = ["setuptools>=61.0.0", "wheel"]
 [project]
 # Check https://setuptools.pypa.io/en/stable/userguide/quickstart.html for all available sections
 name = "ansys-dpf-core"
-version = "0.14.2.dev0"
+version = "0.14.3.dev0"
 description = "Data Processing Framework - Python Core "
 readme = "README.md"
 requires-python = ">=3.9, <4"

pyproject.toml

@@ -473,9 +473,7 @@ def run_with_args():  # pragma: nocover
     parser.add_argument(
         "--ansys_path", default=None, help="Path to Ansys DPF Server installation directory"
     )
-    parser.add_argument(
-        "--output_path", default=None, help="Path to output directory", required=True
-    )
+    parser.add_argument("--output_path", default=".", help="Path to output directory")
     parser.add_argument("--include_private", action="store_true", help="Include private operators")
     parser.add_argument(
         "--include_composites", action="store_true", help="Include Composites operators"

src/ansys/dpf/core/documentation/generate_operators_doc.py

@@ -16,16 +16,21 @@
 
 
 class quantization(Operator):
-    r"""Applies scaling to precision to all the values from field input, then
-    rounding to the unit.
+    r"""Scales a field to a given precision threshold, then rounds all the
+    values to the unit.
 
 
     Parameters
     ----------
     input_field: Field
-        Input field
-    threshold: float
-        Threshold (precision) desired.
+        Field to quantize.
+    threshold: float or Field
+        Precision threshold desired.
+        Case double : the threshold is applied on all the input field.
+        Case field with one value : the threshold is applied on all the input field.
+        Case field with "numComp" values : each threhsold is applied to the corresponding component of the input field.
+        Case field with the same number of values than the input field : quantization is performed component-wise.
+
 
     Returns
     -------
@@ -66,8 +71,8 @@ def __init__(self, input_field=None, threshold=None, config=None, server=None):
 
     @staticmethod
     def _spec() -> Specification:
-        description = r"""Applies scaling to precision to all the values from field input, then
-rounding to the unit.
+        description = r"""Scales a field to a given precision threshold, then rounds all the
+values to the unit.
 """
         spec = Specification(
             description=description,
@@ -76,13 +81,18 @@ def _spec() -> Specification:
                     name="input_field",
                     type_names=["field"],
                     optional=False,
-                    document=r"""Input field""",
+                    document=r"""Field to quantize.""",
                 ),
                 1: PinSpecification(
                     name="threshold",
-                    type_names=["double"],
+                    type_names=["double", "field"],
                     optional=False,
-                    document=r"""Threshold (precision) desired.""",
+                    document=r"""Precision threshold desired.
+Case double : the threshold is applied on all the input field.
+Case field with one value : the threshold is applied on all the input field.
+Case field with "numComp" values : each threhsold is applied to the corresponding component of the input field.
+Case field with the same number of values than the input field : quantization is performed component-wise.
+""",
                 ),
             },
             map_output_pin_spec={
@@ -165,7 +175,7 @@ def __init__(self, op: Operator):
     def input_field(self) -> Input:
         r"""Allows to connect input_field input to the operator.
 
-        Input field
+        Field to quantize.
 
         Returns
         -------
@@ -186,7 +196,12 @@ def input_field(self) -> Input:
     def threshold(self) -> Input:
         r"""Allows to connect threshold input to the operator.
 
-        Threshold (precision) desired.
+        Precision threshold desired.
+        Case double : the threshold is applied on all the input field.
+        Case field with one value : the threshold is applied on all the input field.
+        Case field with "numComp" values : each threhsold is applied to the corresponding component of the input field.
+        Case field with the same number of values than the input field : quantization is performed component-wise.
+
 
         Returns
         -------

src/ansys/dpf/core/operators/compression/quantization.py

@@ -16,21 +16,25 @@
 
 
 class quantization_fc(Operator):
-    r"""Applies scaling to precision to all the values from fields container
-    input, then rounding to the unit.
+    r"""Scales all the fields of a fields container to a given precision
+    threshold, then rounds all the values to the unit.
 
 
     Parameters
     ----------
     input_fc: FieldsContainer
-        Input fields container
+        Fields container to be quantized.
     threshold: float or Field or FieldsContainer
-        Threshold (precision) desired.
+        Precision threshold desired.
+        Case double : the threshold is applied on all the fields of the input fields container.
+        Case field with one, numComp or input size values : the threshold is used for each field of the input fields container.
+        Case fields container : the corresponding threshold field is found by matching label.
+
 
     Returns
     -------
     output_fc: FieldsContainer
-        Scaled and rounded fields container
+        Quantized fields container.
 
     Examples
     --------
@@ -66,8 +70,8 @@ def __init__(self, input_fc=None, threshold=None, config=None, server=None):
 
     @staticmethod
     def _spec() -> Specification:
-        description = r"""Applies scaling to precision to all the values from fields container
-input, then rounding to the unit.
+        description = r"""Scales all the fields of a fields container to a given precision
+threshold, then rounds all the values to the unit.
 """
         spec = Specification(
             description=description,
@@ -76,21 +80,25 @@ def _spec() -> Specification:
                     name="input_fc",
                     type_names=["fields_container"],
                     optional=False,
-                    document=r"""Input fields container""",
+                    document=r"""Fields container to be quantized.""",
                 ),
                 1: PinSpecification(
                     name="threshold",
                     type_names=["double", "field", "fields_container"],
                     optional=False,
-                    document=r"""Threshold (precision) desired.""",
+                    document=r"""Precision threshold desired.
+Case double : the threshold is applied on all the fields of the input fields container.
+Case field with one, numComp or input size values : the threshold is used for each field of the input fields container.
+Case fields container : the corresponding threshold field is found by matching label.
+""",
                 ),
             },
             map_output_pin_spec={
                 0: PinSpecification(
                     name="output_fc",
                     type_names=["fields_container"],
                     optional=False,
-                    document=r"""Scaled and rounded fields container""",
+                    document=r"""Quantized fields container.""",
                 ),
             },
         )
@@ -165,7 +173,7 @@ def __init__(self, op: Operator):
     def input_fc(self) -> Input:
         r"""Allows to connect input_fc input to the operator.
 
-        Input fields container
+        Fields container to be quantized.
 
         Returns
         -------
@@ -186,7 +194,11 @@ def input_fc(self) -> Input:
     def threshold(self) -> Input:
         r"""Allows to connect threshold input to the operator.
 
-        Threshold (precision) desired.
+        Precision threshold desired.
+        Case double : the threshold is applied on all the fields of the input fields container.
+        Case field with one, numComp or input size values : the threshold is used for each field of the input fields container.
+        Case fields container : the corresponding threshold field is found by matching label.
+
 
         Returns
         -------
@@ -225,7 +237,7 @@ def __init__(self, op: Operator):
     def output_fc(self) -> Output:
         r"""Allows to get output_fc output of the operator
 
-        Scaled and rounded fields container
+        Quantized fields container.
 
         Returns
         -------

src/ansys/dpf/core/operators/compression/quantization_fc.py

@@ -25,16 +25,16 @@ class time_freq_support_get_attribute(Operator):
     ----------
     time_freq_support: TimeFreqSupport
     property_name: str
-        Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs".
-    property_identifier: int, optional
-        Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping.
+        Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs", "step_id_from_harmonic_index".
+    property_identifier: int or Scoping, optional
+        Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping, for "step_id_from_harmonic_index" : the harmonic index.
     property_identifier_2: int, optional
         Additional pin for properties "set_id" and "cummulative_index": the substep id (if none, last substep is considered).
 
     Returns
     -------
     property: float or Field or Scoping
-        Returns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", and a Field otherwise.
+        Returns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", an int for "step_id_from_harmonic_index" and a Field otherwise.
 
     Examples
     --------
@@ -106,13 +106,13 @@ def _spec() -> Specification:
                     name="property_name",
                     type_names=["string"],
                     optional=False,
-                    document=r"""Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs".""",
+                    document=r"""Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs", "step_id_from_harmonic_index".""",
                 ),
                 2: PinSpecification(
                     name="property_identifier",
-                    type_names=["int32"],
+                    type_names=["int32", "scoping"],
                     optional=True,
-                    document=r"""Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping.""",
+                    document=r"""Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping, for "step_id_from_harmonic_index" : the harmonic index.""",
                 ),
                 3: PinSpecification(
                     name="property_identifier_2",
@@ -126,7 +126,7 @@ def _spec() -> Specification:
                     name="property",
                     type_names=["double", "field", "scoping"],
                     optional=False,
-                    document=r"""Returns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", and a Field otherwise.""",
+                    document=r"""Returns a double for property: "frequency_tolerance", a single-value Scoping for properties for "set_id" and "cummulative_index", an int for "step_id_from_harmonic_index" and a Field otherwise.""",
                 ),
             },
         )
@@ -238,7 +238,7 @@ def time_freq_support(self) -> Input:
     def property_name(self) -> Input:
         r"""Allows to connect property_name input to the operator.
 
-        Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs".
+        Supported property names are: "time_freqs", "imaginary_freqs", "frequency_tolerance", "set_id", "cummulative_index", "sets_freqs", "step_id_from_harmonic_index".
 
         Returns
         -------
@@ -259,7 +259,7 @@ def property_name(self) -> Input:
     def property_identifier(self) -> Input:
         r"""Allows to connect property_identifier input to the operator.
 
-        Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping.
+        Additional pin for properties "set_id" and "cummulative_index": the step id, for "sets_freqs": the sets scoping, for "step_id_from_harmonic_index" : the harmonic index.
 
         Returns
         -------