feat: adding PyMAPDL + PyDPF example

.ci/display_test.py

@@ -0,0 +1,30 @@
+# Copyright (C) 2024 - 2025 ANSYS, Inc. and/or its affiliates.
+# SPDX-License-Identifier: MIT
+#
+#
+# Permission is hereby granted, free of charge, to any person obtaining a copy
+# of this software and associated documentation files (the "Software"), to deal
+# in the Software without restriction, including without limitation the rights
+# to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+# copies of the Software, and to permit persons to whom the Software is
+# furnished to do so, subject to the following conditions:
+#
+# The above copyright notice and this permission notice shall be included in all
+# copies or substantial portions of the Software.
+#
+# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+# IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+# FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+# AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+# LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+# OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+# SOFTWARE.
+
+"""Quickly check if VTK off screen plotting works."""
+
+import pyvista
+from pyvista.plotting import system_supports_plotting
+
+print("system_supports_plotting", system_supports_plotting())
+pyvista.OFF_SCREEN = True
+pyvista.plot(pyvista.Sphere())

.ci/start_mapdl.sh

@@ -0,0 +1,154 @@
+#!/bin/bash
+# This script is modified to start MAPDL directly inside a container (no Docker-in-Docker)
+#
+# Usage:
+# ------
+# This script is intended to be run in a CI/CD environment where we're already inside a MAPDL container.
+#
+# Required environment variables:
+# -------------------------------
+#
+# - DISTRIBUTED_MODE: The mode of operation for MAPDL (e.g., "smp", "dmp").
+# - DPF_PORT: The port for the DPF service (e.g., 50055).
+# - INSTANCE_NAME: The name of the MAPDL instance (e.g., "MAPDL_0").
+# - LICENSE_SERVER: The address of the license server (e.g., "123.123.123.123").
+# - MAPDL_VERSION: The version of the MAPDL image to use (e.g., "v25.2-ubuntu-cicd").
+# - PYMAPDL_DB_PORT: The port for the PyMAPDL database service (e.g., 50056).
+# - PYMAPDL_PORT: The port for the PyMAPDL service (e.g., 50052).
+#
+
+export MAJOR MINOR VERSION
+
+echo "MAPDL Instance name: $INSTANCE_NAME"
+echo "MAPDL_VERSION: $MAPDL_VERSION"
+echo "Running inside container - no Docker pull needed"
+
+# Extract version from MAPDL_VERSION
+MAJOR=$(echo "$MAPDL_VERSION" | head -c 3 | tail -c 2)
+MINOR=$(echo "$MAPDL_VERSION" | head -c 5 | tail -c 1)
+
+VERSION="$MAJOR$MINOR"
+echo "MAPDL VERSION: $VERSION"
+
+# Determine executable path based on image type
+if [[ $MAPDL_VERSION == *"latest-ubuntu"* ]]; then
+    echo "It is latest-ubuntu. Using 'ansys' script to launch"
+    EXEC_PATH=ansys
+    P_SCHEMA=/ansys_inc/ansys/ac4/schema
+
+elif [[ $MAPDL_VERSION == *"ubuntu"* ]] ; then
+    echo "It is an ubuntu based image"
+    EXEC_PATH=/ansys_inc/v$VERSION/ansys/bin/mapdl
+    P_SCHEMA=/ansys_inc/v$VERSION/ansys/ac4/schema
+
+else
+    echo "It is a CentOS based image"
+    EXEC_PATH=/ansys_inc/ansys/bin/mapdl
+    P_SCHEMA=/ansys_inc/ansys/ac4/schema
+fi;
+
+echo "EXEC_PATH: $EXEC_PATH"
+echo "P_SCHEMA: $P_SCHEMA"
+
+# Handle CICD version specifics
+if [[ $MAPDL_VERSION == *"cicd"* ]] ; then
+    echo "It is a CICD version"
+    if [ "$RUN_DPF_SERVER" == "true" ]; then
+        echo "RUN_DPF_SERVER is set to true, DPF will be available"
+        export ANSYS_DPF_ACCEPT_LA=Y
+    fi
+
+    echo "DPF_PORT: $DPF_PORT"
+    echo "PYMAPDL_DB_PORT: $PYMAPDL_DB_PORT"
+
+    echo "Setting DISTRIBUTED_MODE to $DISTRIBUTED_MODE for CICD version"
+else
+    export PYMAPDL_DB_PORT=DPF_PORT
+fi;
+
+echo "EXEC_PATH: $EXEC_PATH"
+echo "P_SCHEMA: $P_SCHEMA"
+
+# Verify executable exists
+if [ ! -f "$EXEC_PATH" ] && [ "$EXEC_PATH" != "ansys" ]; then
+    echo "Executable not found at $EXEC_PATH, searching for alternatives..."
+
+    # Try alternative paths
+    ALTERNATIVE_PATHS=(
+        "/ansys_inc/v$VERSION/ansys/bin/ansys$VERSION"
+        "/ansys_inc/ansys/bin/mapdl"
+        "/ansys_inc/ansys/bin/ansys$VERSION"
+        "/opt/ansys_inc/v$VERSION/ansys/bin/mapdl"
+    )
+
+    for alt_path in "${ALTERNATIVE_PATHS[@]}"; do
+        if [ -f "$alt_path" ]; then
+            EXEC_PATH="$alt_path"
+            echo "Found alternative executable: $EXEC_PATH"
+            break
+        fi
+    done
+
+    # If still not found, try which command
+    if [ ! -f "$EXEC_PATH" ]; then
+        if command -v "ansys$VERSION" >/dev/null 2>&1; then
+            EXEC_PATH="ansys$VERSION"
+            echo "Using system command: $EXEC_PATH"
+        else
+            echo "ERROR: Could not find MAPDL executable"
+            echo "Searched paths:"
+            printf '%s\n' "${ALTERNATIVE_PATHS[@]}"
+            exit 1
+        fi
+    fi
+fi
+
+# Set environment variables for MAPDL
+export ANSYS_LOCK="OFF"
+export I_MPI_SHM_LMT=shm
+export VERSION=$VERSION
+export P_SCHEMA=$P_SCHEMA
+
+# Allow MPI to run as root (required for container environments)
+export OMPI_ALLOW_RUN_AS_ROOT=1
+export OMPI_ALLOW_RUN_AS_ROOT_CONFIRM=1
+
+echo "Starting MAPDL directly in container..."
+echo "Environment variables:"
+echo "  ANSYS_LOCK: $ANSYS_LOCK"
+echo "  I_MPI_SHM_LMT: $I_MPI_SHM_LMT"
+echo "  DISTRIBUTED_MODE: $DISTRIBUTED_MODE"
+echo "  OMPI_ALLOW_RUN_AS_ROOT: $OMPI_ALLOW_RUN_AS_ROOT"
+echo "  OMPI_ALLOW_RUN_AS_ROOT_CONFIRM: $OMPI_ALLOW_RUN_AS_ROOT_CONFIRM"
+echo "  ANSYS_DPF_ACCEPT_LA: $ANSYS_DPF_ACCEPT_LA"
+
+# Start MAPDL using the entrypoint logic directly
+echo "Starting MAPDL with: $EXEC_PATH -grpc -port $PYMAPDL_PORT -$DISTRIBUTED_MODE"
+
+# Create the log file
+touch "${INSTANCE_NAME}.log"
+
+# Start MAPDL in background
+nohup $EXEC_PATH -grpc -port $PYMAPDL_PORT -$DISTRIBUTED_MODE -np 2 >> "${INSTANCE_NAME}.log" 2>&1 &
+MAPDL_PID=$!
+
+# Give MAPDL time to initialize
+echo "Waiting for MAPDL to initialize..."
+
+# Debug: Check immediately and periodically
+for i in {1..10}; do
+    echo "Check $i: Testing process status..."
+
+    # Check process first
+    if ! kill -0 $MAPDL_PID 2>/dev/null; then
+        echo "ERROR: MAPDL process died after $i checks!"
+        echo "Process list:"
+        ps aux | grep mapdl || echo "No MAPDL processes found"
+        exit 1
+    fi
+
+    echo "MAPDL process still alive after $i."
+done
+
+echo "All checks passed - MAPDL process is running (PID: $MAPDL_PID)"
+echo "MAPDL_PID=$MAPDL_PID"

.github/workflows/docs.yml

@@ -14,23 +14,29 @@ jobs:
     uses: ./.github/workflows/geometry-mesh.yml
     secrets: inherit
     with:
-      doc-build: true
+      doc-build: false
 
   geometry-mesh-fluent:
     uses: ./.github/workflows/geometry-mesh-fluent.yml
     secrets: inherit
     with:
-      doc-build: true
+      doc-build: false
 
   geometry-mechanical-dpf:
     uses: ./.github/workflows/geometry-mechanical-dpf.yml
     secrets: inherit
     with:
-      doc-build: true
+      doc-build: false
 
   fluent-mechanical:
     uses: ./.github/workflows/fluent-mechanical.yml
     secrets: inherit
+    with:
+      doc-build: false
+
+  mapdl-dpf:
+    uses: ./.github/workflows/mapdl-dpf.yml
+    secrets: inherit
     with:
       doc-build: true