Merge master

Signed-off-by: paul.profizi <[email protected]>

Author: PProfizi

.ci/build_doc.bat

@@ -1,12 +1,28 @@
 set SPHINX_APIDOC_OPTIONS=inherited-members
-call sphinx-apidoc -o ../docs/source/api ../ansys ../ansys/dpf/core/log.py ^
-../ansys/dpf/core/help.py ../ansys/dpf/core/mapping_types.py ../ansys/dpf/core/ipconfig.py ^
-../ansys/dpf/core/field_base.py ../ansys/dpf/core/cache.py ../ansys/dpf/core/misc.py ^
-../ansys/dpf/core/check_version.py ../ansys/dpf/core/operators/build.py ../ansys/dpf/core/operators/specification.py ^
-../ansys/dpf/core/vtk_helper.py ^
+call sphinx-apidoc -o ../doc/source/api ../src/ansys ../src/ansys/dpf/core/log.py ^
+../src/ansys/dpf/core/help.py ../src/ansys/dpf/core/mapping_types.py ../src/ansys/dpf/core/ipconfig.py ^
+../src/ansys/dpf/core/field_base.py ../src/ansys/dpf/core/cache.py ../src/ansys/dpf/core/misc.py ^
+../src/ansys/dpf/core/check_version.py ../src/ansys/dpf/core/operators/build.py ../src/ansys/dpf/core/operators/specification.py ^
+../src/ansys/dpf/core/vtk_helper.py ../src/ansys/dpf/core/label_space.py ../src/ansys/dpf/core/examples/python_plugins/* ^
+../src/ansys/dpf/core/examples/examples.py ../src/ansys/dpf/gate/* ../src/ansys/dpf/gatebin/* ../src/ansys/grpc/dpf/* ^
+ ../src/ansys/dpf/core/property_fields_container.py ^
  -f --implicit-namespaces --separate  --no-headings
 pushd .
-cd ../docs/
+cd ../doc/
 call make clean
-call make html
+call make html -v -v -v -P
+
+dir
+
+rem Patch pyVista issue with elemental plots
+
+xcopy  source\examples\04-advanced\02-volume_averaged_stress\sphx_glr_02-volume_averaged_stress_001.png   build\html\_images\  /y /f
+xcopy  source\examples\12-fluids\02-fluids_results\sphx_glr_02-fluids_results_001.png                     build\html\_images\  /y /f
+xcopy  source\examples\12-fluids\02-fluids_results\sphx_glr_02-fluids_results_002.png                     build\html\_images\  /y /f
+xcopy  source\examples\12-fluids\02-fluids_results\sphx_glr_02-fluids_results_003.png                     build\html\_images\  /y /f
+xcopy  source\examples\12-fluids\02-fluids_results\sphx_glr_02-fluids_results_004.png                     build\html\_images\  /y /f
+xcopy  source\examples\12-fluids\02-fluids_results\sphx_glr_02-fluids_results_005.png                     build\html\_images\  /y /f
+xcopy  source\examples\12-fluids\02-fluids_results\sphx_glr_02-fluids_results_006.png                     build\html\_images\  /y /f
+xcopy  source\examples\12-fluids\02-fluids_results\sphx_glr_02-fluids_results_007.png                     build\html\_images\  /y /f
+xcopy  source\examples\12-fluids\02-fluids_results\sphx_glr_02-fluids_results_thumb.png                   build\html\_images\  /y /f
 popd

.ci/build_operators_doc.py

@@ -0,0 +1,11 @@
+import ansys.dpf.core as dpf
+from ansys.dpf.core.server_context import (
+    SERVER_CONTEXT,
+)
+
+print(f"Server version: {dpf.global_server().version}")
+# Generate entry documentation
+print("Generating operator documentation")
+print(f"Current context: {SERVER_CONTEXT}")
+dpf.operators.utility.html_doc(r"../doc/source/_static/dpf_operators.html").eval()
+print("Done.\n")

.ci/build_wheel.py

@@ -0,0 +1,94 @@
+# This script generates the different versions of the ansys-dpf-core wheels based on a given input.
+# Input can be one of ["any", "win", "manylinux1", "manylinux_2_17"]
+
+import argparse
+import subprocess
+import os
+import sys
+import shutil
+import tempfile
+
+
+supported_platforms = {
+    "any": "any",
+    "win": "win_amd64",
+    "manylinux1": "manylinux1_x86_64",
+    "manylinux_2_17": "manylinux_2_17_x86_64",
+}
+
+argParser = argparse.ArgumentParser()
+argParser.add_argument("-p", "--platform", help="platform")
+argParser.add_argument("-w", "--wheelhouse", help="platform", action="store_true")
+
+args = argParser.parse_args()
+
+if args.platform not in supported_platforms:
+    raise ValueError(
+        f"Platform {args.platform} is not supported. "
+        f"Supported platforms are: {list(supported_platforms.keys())}"
+    )
+else:
+    requested_platform = supported_platforms[args.platform]
+print(requested_platform)
+
+# Move binaries out of the source depending on platform requested
+# any: move all binaries out before building
+# win: move .so binaries out before building
+# lin: move .dll binaries out before building
+with tempfile.TemporaryDirectory() as tmpdirname:
+    print("Created temporary directory: ", tmpdirname)
+
+    # Create the temporary build-opts.cfg
+    build_opts_path = os.path.join(tmpdirname, "build-opts.cfg")
+    with open(build_opts_path, "w") as build_opts_file:
+        build_opts_file.write(f"[bdist_wheel]\nplat-name={requested_platform}")
+    os.environ["DIST_EXTRA_CONFIG"] = build_opts_path
+
+    # Move the binaries
+    gatebin_folder_path = os.path.join(
+        os.path.curdir, os.path.join("src", "ansys", "dpf", "gatebin")
+    )
+    binaries_to_move = []
+    moved = []
+    if "win" in requested_platform or "any" == requested_platform:
+        # Move linux binaries
+        binaries_to_move.extend(["libAns.Dpf.GrpcClient.so", "libDPFClientAPI.so"])
+    if "linux" in requested_platform or "any" == requested_platform:
+        # Move windows binaries
+        binaries_to_move.extend(["Ans.Dpf.GrpcClient.dll", "DPFClientAPI.dll"])
+    if "any" == requested_platform:
+        binaries_to_move.extend(["_version.py"])
+
+    for binary_name in binaries_to_move:
+        src = os.path.join(gatebin_folder_path, binary_name)
+        dst = os.path.join(tmpdirname, binary_name)
+        print(f"Moving {src} to {dst}")
+        shutil.move(src=src, dst=dst)
+        moved.append([dst, src])
+
+    if "any" == requested_platform:
+        # Also remove the gatebin folder
+        os.rmdir(gatebin_folder_path)
+
+    # Call the build
+    if not args.wheelhouse:
+        cmd = [sys.executable, "-m", "build", "--wheel"]
+    else:
+        cmd = [sys.executable, "-m", "pip", "wheel", "-w", "dist", "."]
+    try:
+        subprocess.run(cmd, capture_output=False, text=True)
+        print("Done building the wheel.")
+    except Exception as e:
+        print(f"Build failed with error: {e}")
+
+    if "any" == requested_platform:
+        # Recreate the gatebin folder
+        os.mkdir(gatebin_folder_path)
+
+    # Move binaries back
+    for move_back in moved:
+        print(f"Moving back {move_back[0]} to {move_back[1]}")
+        shutil.move(src=move_back[0], dst=move_back[1])
+    print("Binaries moved back.")
+
+    print(f"Done building {requested_platform} wheel for ansys-dpf-core!")

.ci/code_generation.py

@@ -1,42 +1,15 @@
+# import subprocess
+
 from ansys.dpf import core
+from ansys.dpf.core.operators import build
 import os
 import glob
 from pathlib import Path
-import time
 import shutil
 
-if os.name == "posix":
-    LIB_TO_GENERATE = [
-        "libAns.Dpf.Native.so",
-        "libAns.Dpf.FEMutils.so",
-        "libmapdlOperatorsCore.so",
-        "libmeshOperatorsCore.so",
-        "libAns.Dpf.Math.so",
-        "libAns.Dpf.Hdf5.so",
-        "libAns.Dpf.LSDYNAHGP.so",
-        "libAns.Dpf.LivePost.so",
-        "libans.dpf.pointcloudsearch.so",
-        "libAns.Dpf.Vtk.so",
-    ]
-else:
-    LIB_TO_GENERATE = [
-        "Ans.Dpf.Native.dll",
-        "Ans.Dpf.Mechanical.dll",
-        "Ans.Dpf.FEMutils.dll",
-        "meshOperatorsCore.dll",
-        "mapdlOperatorsCore.dll",
-        "Ans.Dpf.Math.dll",
-        "Ans.Dpf.PythonPluginWrapper.dll"
-        "Ans.Dpf.Hdf5.dll",
-        "Ans.Dpf.FlowDiagram.dll",
-        "Ans.Dpf.LSDYNAHGP.dll",
-        "Ans.Dpf.LivePost.dll",
-        "Ans.Dpf.PointCloudSearch.dll",
-        "Ans.Dpf.Vtk.dll",
-    ]
 
 local_dir = os.path.dirname(os.path.abspath(__file__))
-TARGET_PATH = os.path.join(local_dir, os.pardir, "ansys", "dpf", "core", "operators")
+TARGET_PATH = os.path.join(local_dir, os.pardir, "src", "ansys", "dpf", "core", "operators")
 files = glob.glob(os.path.join(TARGET_PATH, "*"))
 for f in files:
     if Path(f).stem == "specification":
@@ -52,14 +25,8 @@
             os.remove(f)
     except:
         pass
+
+core.set_default_server_context(core.AvailableServerContexts.premium)
 core.start_local_server(config=core.AvailableServerConfigs.LegacyGrpcServer)
-code_gen = core.Operator("python_generator")
-code_gen.connect(1, TARGET_PATH)
-for lib in LIB_TO_GENERATE:
-    code_gen.connect(0, lib)
-    if lib != LIB_TO_GENERATE[0]:
-        code_gen.connect(2, False)
-    else:
-        code_gen.connect(2, True)
-    code_gen.run()
-    time.sleep(0.1)
+
+build.build_operators()

.ci/display_test.py

@@ -4,23 +4,42 @@
 import subprocess
 import sys
 
+import ansys.dpf.core as dpf
+from ansys.dpf.core.examples import get_example_required_minimum_dpf_version
+
+
 os.environ["PYVISTA_OFF_SCREEN"] = "true"
 os.environ["MPLBACKEND"] = "Agg"
 
 actual_path = pathlib.Path(__file__).parent.absolute()
 print(os.path.join(actual_path, os.path.pardir, "examples"))
 
+# Get the DPF server version
+server = dpf.server.get_or_create_server(None)
+server_version = server.version
+server.shutdown()
+print(f"Server version: {server_version}")
 
 for root, subdirectories, files in os.walk(os.path.join(actual_path, os.path.pardir, "examples")):
     for subdirectory in subdirectories:
         subdir = os.path.join(root, subdirectory)
         for file in glob.iglob(os.path.join(subdir, "*.py")):
-            print("\n\n--------------------------------------------------\n")
+            if sys.platform == "linux" and "08-python-operators" in file:
+                continue
+            elif "win" in sys.platform and "06-distributed_stress_averaging" in file:
+                # Currently very unstable in the GH CI
+                continue
+            print("\n--------------------------------------------------")
             print(file)
-            print("--------------------------------------------------\n")
+            minimum_version_str = get_example_required_minimum_dpf_version(file)
+            if float(server_version) - float(minimum_version_str) < -0.05:
+                print(f"Example skipped as it requires DPF {minimum_version_str}.")
+                continue
             try:
-                subprocess.check_call([sys.executable, file])
+                out = subprocess.check_output([sys.executable, file])
             except subprocess.CalledProcessError as e:
                 sys.stderr.write(str(e.args))
                 if e.returncode != 3221225477:
+                    print(out)
                     raise e
+            print("PASS")

.ci/requirements_test_xvfb.txt

@@ -14,38 +14,56 @@
 
 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", "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",
-                 "05-plot_on_warped_mesh.py"),
-    os.path.join(actual_path, os.path.pardir, "examples", "06-distributed-post",
-                 "00-distributed_total_disp.py"),
-    ]
+    os.path.join(actual_path, os.path.pardir, "examples", "01-transient_analyses"),
+    os.path.join(actual_path, os.path.pardir, "examples", "02-modal_analyses"),
+    os.path.join(actual_path, os.path.pardir, "examples", "03-harmonic_analyses"),
+    os.path.join(actual_path, os.path.pardir, "examples", "06-plotting", "00-basic_plotting.py"),
+    os.path.join(
+        actual_path,
+        os.path.pardir,
+        "examples",
+        "06-plotting",
+        "05-plot_on_warped_mesh.py",
+    ),
+    os.path.join(
+        actual_path,
+        os.path.pardir,
+        "examples",
+        "07-distributed-post",
+        "00-distributed_total_disp.py",
+    ),
+]
 
 if core.SERVER_CONFIGURATION != core.AvailableServerConfigs.InProcessServer:
-    list_tests.append(os.path.join(actual_path, os.path.pardir, "examples", "07-python-operators",
-                 "00-wrapping_numpy_capabilities.py"))
+    list_tests.append(
+        os.path.join(
+            actual_path,
+            os.path.pardir,
+            "examples",
+            "08-python-operators",
+            "00-wrapping_numpy_capabilities.py",
+        )
+    )
 
 for path in list_tests:
     if os.path.isdir(path):
         for file in glob.iglob(os.path.join(path, "*.py")):
-            print("\n\n--------------------------------------------------\n")
+            print("\n--------------------------------------------------")
             print(file)
-            print("--------------------------------------------------\n")
             try:
                 subprocess.check_call([sys.executable, file])
             except subprocess.CalledProcessError as e:
                 sys.stderr.write(str(e.args))
                 if e.returncode != 3221225477:
                     raise e
+            print("PASS")
     else:
-        print("\n\n--------------------------------------------------\n")
+        print("\n--------------------------------------------------")
         print(path)
-        print("--------------------------------------------------\n")
         try:
             subprocess.check_call([sys.executable, file])
         except subprocess.CalledProcessError as e:
             sys.stderr.write(str(e.args))
             if e.returncode != 3221225477:
                 raise e
+        print("PASS")