Merge branch 'main' into DPF_261/daily_doc_update

Author: PProfizi

2025R2/dpf-framework-25-r2/changelog/changelog-25-r2.md renamed to 2025R2/dpf-framework-25-r2/changelog/changelog.md

@@ -1,31 +1,11 @@
 # Changelog
 
-This changelog is organized by category, with sections for new features, changes, fixes, and performance improvements. The following table shows which components have updates in each category.
-
-| Component | Features | Changes | Fixes | Performance |
-|-----------|----------|---------|-------|-------------|
-| Framework | ✅ [15 items](#features_framework) | ✅ [4 items](#changes_framework) | ✅ [33 items](#fixes_framework) | ✅ [9 items](#performance_framework) |
-| HGP | ✅ [4 items](#features_hgp) | ✅ [1 item](#changes_hgp) | ✅ [6 items](#fixes_hgp) | ✅ [2 items](#performance_hgp) |
-| MAPDL | ✅ [11 items](#features_mapdl) | ✅ [3 items](#changes_mapdl) | ✅ [29 items](#fixes_mapdl) | ✅ [3 items](#performance_mapdl) |
-| LSDYNA | ✅ [2 items](#features_lsdyna) | ✅ [2 items](#changes_lsdyna) | ✅ [8 items](#fixes_lsdyna) | ❌ |
-| Math | ✅ [1 item](#features_math) | ✅ [2 items](#changes_math) | ✅ [1 item](#fixes_math) | ❌ |
-| HDF5 | ✅ [3 items](#features_hdf5) | ✅ [1 item](#changes_hdf5) | ✅ [8 items](#fixes_hdf5) | ❌ |
-| CFF | ❌ | ✅ [1 item](#changes_cff) | ✅ [2 items](#fixes_cff) | ❌ |
-| Compression | ✅ [1 item](#features_compression) | ❌ | ❌ | ✅ [1 item](#performance_compression) |
-| Documentation | ✅ [1 item](#features_documentation) | ❌ | ❌ | ❌ |
-| Motion | ✅ [1 item](#features_motion) | ❌ | ❌ | ❌ |
-| CGNS | ✅ [1 item](#features_cgns) | ❌ | ❌ | ❌ |
-| Engineering Data | ❌ | ✅ [1 item](#changes_engineering_data) | ❌ | ❌ |
-| VTK | ❌ | ❌ | ✅ [1 item](#fixes_vtk) | ❌ |
-
-**Legend:**
-
-- ✅ = Updates available in this category
-- ❌ = No updates in this category
-- Numbers in brackets indicate the count of items in each section
+This changelog is organized by category, with sections for new features, changes, fixes, and performance improvements. 
 
 ## Table of contents
+
 ### Features categories
+
   * [Framework](#features_framework)
   * [HGP](#features_hgp)
   * [MAPDL](#features_mapdl)
@@ -38,6 +18,7 @@ This changelog is organized by category, with sections for new features, changes
   * [CGNS](#features_cgns)
 
 ### Changes categories
+
   * [Framework](#changes_framework)
   * [HGP](#changes_hgp)
   * [MAPDL](#changes_mapdl)
@@ -48,6 +29,7 @@ This changelog is organized by category, with sections for new features, changes
   * [Engineering Data](#changes_engineering_data)
 
 ### Fixes categories
+
   * [Framework](#fixes_framework)
   * [HGP](#fixes_hgp)
   * [MAPDL](#fixes_mapdl)
@@ -58,6 +40,7 @@ This changelog is organized by category, with sections for new features, changes
   * [VTK](#fixes_vtk)
 
 ### Performance improvements categories
+
   * [Framework](#performance_framework)
   * [HGP](#performance_hgp)
   * [MAPDL](#performance_mapdl)

2025R2/dpf-framework-25-r2/toc.yml

@@ -1809,4 +1809,4 @@
     - name: weighted merge fields by label
       href: operator-specifications/utility/weighted_merge_fields_by_label.md
 - name: Changelog
-  href: changelog/changelog-25-r2.md
+  href: changelog/changelog.md

2025R2/dpf-framework-25-r2/user-guide/dpf-docs-local-preview.md

@@ -18,7 +18,7 @@ This guide shows you how to create your own local copy of the DPF Framework docu
 This step-by-step guide walks you through:
 
 - How to use basic command-line tools.
-- How to create a local website to view your custom documentation.
+- How to create a local website to view your DPF Framework HTML documentation.
 - How to update the "Operator specifications" section of your documentation based on a custom DPF installation.
 
 ## About the command line
@@ -42,7 +42,8 @@ This guide uses the **command line** (also called terminal or PowerShell on Wind
 Create a local website to view DPF Framework documentation in a user-friendly format (like a regular website with navigation and search).
 The DPF Framework documentation includes both general reference material and the DPF operators documentation.
 
-You first get the sources for the official documentation at https://github.com/ansys/DevRelDocs, then update them locally, and generate a local website. 
+First, install the DocFX website builder. Next, clone the official documentation source from [github.com/ansys/DevRelDocs](https://github.com/ansys/DevRelDocs). Use DocFX to generate a local version of the website.
+
 
 ### Step 1: Install the website builder (DocFX)
 
@@ -150,7 +151,7 @@ Download and install the latest stable version of Python from the https://www.py
 
 If you want to use older versions of Python, the minimum version supported by ansys-dpf-core is 3.10.
 
-1. **Test your Python installation** by typing:
+ **Test your Python installation** by typing:
 
    ```powershell
    python --version
@@ -217,19 +218,18 @@ You need to install the DPF server software. Select the installation method that
    $env:ANSYS_DPF_ACCEPT_LA = "Y"
    ```
 
-1. **Set your license server** by typing:
+2. **Set your license server** by typing:
 
    ```powershell
    $env:ANSYSLMD_LICENSE_FILE = "1055@your-license-address" 
    ```
 
    **What these do:** Configure DPF to work with your license and permissions. See [Licensing](../getting-started/licensing.md) section for more information.
 
-### Step 4: Update the DPF operators documentation
+### Step 3: Update the DPF operators documentation
 
 Next, generate the DPF operators Markdown documentation files. Choose the option that fits your needs.
 
-
 **Update the current documentation with the default DPF installation:**
 
 Move to the root folder of the ``dpf-framework`` documentation downloaded in section ``Create your DPF Framework HTML documentation``, step ``Get the DPF Framework documentation source files``.
@@ -278,7 +278,7 @@ Generate the output files for all operators including private operators with the
 dpf_generate_operators_doc.exe --include_private
 ```
 
-#### Optional: Document composites operators
+#### Optional: Document Composites operators
 
 Generate the output files for all operators including operators of the ``Composites`` DPF plugin with the ``--include_composites`` command argument:
 
@@ -289,7 +289,7 @@ dpf_generate_operators_doc.exe --include_composites
 This is useful for installations where the ``Composites`` plugin is present but not loaded by default.
 This tells the script to try and load the plugin when starting DPF.
 
-#### Optional: Document composites operators
+#### Optional: Document Sound operators
 
 Generate the output files for all operators including operators of the ``Sound`` DPF plugin with the ``--include_sound`` command argument:
 
@@ -330,9 +330,9 @@ dpf_generate_operators_doc.exe --plugin "mesh"
 
 **What this does:** Creates documentation only for the specified plugin.
 
-### Step 5: Rebuild the documentation
+### Step 4: Rebuild the documentation
 
-Refer to the previous main section "Create your DPF Framework HTML documentation" and "Step 3: Generate a local website" to update the HTML documentation with the new content for DPF operators.
+Refer to the previous main section [Create your DPF Framework HTML documentation](#create-your-dpf-framework-html-documentation) and **Step 3: Generate a local website** to update the HTML documentation with the new content for DPF operators.
 
 ## Troubleshooting
 

2025R2_SP1/primemesh-25-r2-sp1/add-header-to-tables.py

@@ -0,0 +1,135 @@
+import os
+import sys
+import argparse
+
+
+def remove_column_table(input_table):
+    # Split input table into rows
+    rows = input_table.strip().split('\n')
+
+    # Create a new array for modified table
+    modified_rows = []
+
+    # Add the new header row
+    modified_rows.append("| Name |")
+
+   # invert row[0] and row[1]
+    temp = rows[0]
+    rows[0] = rows[1]
+    rows[1] = temp
+    
+
+    # Skip the second row of the original table
+    # We don't include it in the modified table
+
+    # Add remaining rows from the original table, starting from index 2
+    for i in range(0, len(rows)):
+        # Split the current row by the '|' character
+        columns = rows[i].strip().split('|')
+
+        # Extract the content of the first column
+        name_column = columns[1].strip()
+
+        # Add the content of the first column to the modified row
+        modified_rows.append("| " + name_column + " |")
+
+    # Construct the modified table string
+    modified_table = '\n'.join(modified_rows)
+    
+    return modified_table
+    
+def process_md_table(input_table):
+    # Split input table into rows
+    rows = input_table.strip().split('\n')
+
+    # Create a new array for modified table
+    modified_rows = ["| Name | Description |"]
+
+    # Add the second row of the original table
+    modified_rows.append(rows[1])
+
+    # Add the first row of the original table
+    modified_rows.append(rows[0])
+
+    # Add remaining rows from the original table, starting from index 2
+    for i in range(2, len(rows)):
+        modified_rows.append(rows[i])
+
+    # Construct the modified table string
+    modified_table = '\n'.join(modified_rows)
+
+    return modified_table
+
+def process_md_files(folder_path):
+    # Traverse the directory structure recursively
+    for root, dirs, files in os.walk(folder_path):
+        for file in files:
+            # Check if the file is a Markdown file
+            if file.endswith(".md"):
+                file_path = os.path.join(root, file)
+                print("Processing:", file_path)
+                # Read the input file
+                with open(file_path, 'r', encoding='utf-8') as file:
+                    file_content = file.read()
+
+                # Split the file content by at least one newline character
+                tables = file_content.split('\n\n')
+
+                # Process each potential Markdown table found in the file
+                modified_tables = []
+
+                # Check if all items of column 2 are empty
+                for table in tables:
+                    # Check if the potential table is actually a Markdown table
+                    if table.strip().startswith('|'):
+                        # Check if the table has two columns with an empty column (first row only)
+                        rows = table.strip().split('\n')
+                        is2ColumnTable = False
+                        for i in range(0, len(rows)):
+                                if i==1:
+                                    continue
+                                if rows[i].count('|') == 3:
+                                    s = rows[i].split('|')[2]
+                                    if all(char.isspace() or char == '\t' for char in s):
+                                        print("Found 1 column table")
+                                    else:
+                                        print("Found 2 column table")
+                                        is2ColumnTable = True
+
+                        if rows[0].count('|') > 3:
+                             print("Found >2 column table")
+                        elif is2ColumnTable == True:
+                             # Process the MD table
+                             modified_table = process_md_table(table)
+                        elif is2ColumnTable == False:
+                             # Remove the empty column from the table
+                             modified_table = remove_column_table(table)   
+                    else:
+                        modified_table = table
+                        
+                    modified_tables.append(modified_table)
+
+                # Join the modified tables back into the file content
+                modified_content = '\n\n'.join(modified_tables)
+
+                # Write the modified content back to the input file
+                with open(file_path, 'w', encoding='utf-8') as file:
+                    file.write(modified_content)
+
+                print("File '{}' has been updated with corrected tables.".format(file_path))
+
+if __name__ == "__main__":
+    # Check if the folder path is provided
+
+
+    # Get the folder path from command line argument
+    #folder_path = sys.argv[1]
+
+    parser = argparse.ArgumentParser(description="Add headers to tables in Markdown files.")
+    parser.add_argument("--input_folder", help="Path to the folder of Markdown files")
+    args = parser.parse_args()
+
+    folder_path = args.input_folder
+
+    # Process all Markdown files in the folder and its subfolders
+    process_md_files(folder_path)

2025R2_SP1/primemesh-25-r2-sp1/api/_autosummary/ansys.meshing.prime.AddLabelResults.error_code.md

@@ -0,0 +1,9 @@
+# ansys.meshing.prime.AddLabelResults.error_code
+
+<a id="ansys.meshing.prime.AddLabelResults.error_code"></a>
+
+#### *property* AddLabelResults.error_code *: [ErrorCode](ansys.meshing.prime.ErrorCode.md#ansys.meshing.prime.ErrorCode)*
+
+Error code associated with the add label operation.
+
+<!-- !! processed by numpydoc !! -->

2025R2_SP1/primemesh-25-r2-sp1/api/_autosummary/ansys.meshing.prime.AddLabelResults.md

@@ -0,0 +1,44 @@
+<!-- vale off -->
+
+<a id="addlabelresults"></a>
+
+# AddLabelResults
+
+<a id="ansys.meshing.prime.AddLabelResults"></a>
+
+### *class* ansys.meshing.prime.AddLabelResults(model=None, error_code=None, json_data=None, \*\*kwargs)
+
+Results associated with the add label operation.
+
+* **Parameters:**
+
+  **model: Model**
+  : Model to create a `AddLabelResults` object with default parameters.
+
+  **error_code: ErrorCode, optional**
+  : Error code associated with the add label operation.
+
+  **json_data: dict, optional**
+  : JSON dictionary to create a `AddLabelResults` object with provided parameters.
+
+### Examples
+
+```pycon
+>>> add_label_results = prime.AddLabelResults(model = model)
+```
+
+<!-- !! processed by numpydoc !! -->
+
+### Methods
+
+| Name | Description |
+|---------------------------------------------------------------------------------------------------------------------------------------------------|---------------------------------------------------------|
+| [`AddLabelResults.print_default`](ansys.meshing.prime.AddLabelResults.print_default.md#ansys.meshing.prime.AddLabelResults.print_default)()       | Print the default values of `AddLabelResults` object.   |
+| [`AddLabelResults.set_default`](ansys.meshing.prime.AddLabelResults.set_default.md#ansys.meshing.prime.AddLabelResults.set_default)([error_code]) | Set the default values of the `AddLabelResults` object. |
+
+### Attributes
+
+| Name | Description |
+|------------------------------------------------------------------------------------------------------------------------------------|-------------------------------------------------------|
+| [`AddLabelResults.error_code`](ansys.meshing.prime.AddLabelResults.error_code.md#ansys.meshing.prime.AddLabelResults.error_code)   | Error code associated with the add label operation.   |
+<!-- vale on -->

2025R2_SP1/primemesh-25-r2-sp1/api/_autosummary/ansys.meshing.prime.AddLabelResults.print_default.md

@@ -0,0 +1,15 @@
+# print_default
+
+<a id="ansys.meshing.prime.AddLabelResults.print_default"></a>
+
+#### *static* AddLabelResults.print_default()
+
+Print the default values of `AddLabelResults` object.
+
+### Examples
+
+```pycon
+>>> AddLabelResults.print_default()
+```
+
+<!-- !! processed by numpydoc !! -->

2025R2_SP1/primemesh-25-r2-sp1/api/_autosummary/ansys.meshing.prime.AddLabelResults.set_default.md

@@ -0,0 +1,14 @@
+# set_default
+
+<a id="ansys.meshing.prime.AddLabelResults.set_default"></a>
+
+#### *static* AddLabelResults.set_default(error_code=None)
+
+Set the default values of the `AddLabelResults` object.
+
+* **Parameters:**
+
+  **error_code: ErrorCode, optional**
+  : Error code associated with the add label operation.
+
+<!-- !! processed by numpydoc !! -->

2025R2_SP1/primemesh-25-r2-sp1/api/_autosummary/ansys.meshing.prime.AddThicknessParams.fix_intersections.md

@@ -0,0 +1,9 @@
+# ansys.meshing.prime.AddThicknessParams.fix_intersections
+
+<a id="ansys.meshing.prime.AddThicknessParams.fix_intersections"></a>
+
+#### *property* AddThicknessParams.fix_intersections *: [bool](https://docs.python.org/3.11/library/functions.html#bool)*
+
+Fix intersections in concave regions.
+
+<!-- !! processed by numpydoc !! -->