FEAT: PyFluent - PyMechanical exhaust manifold workflow

.github/workflows/docs.yml

@@ -14,23 +14,29 @@ jobs:
     uses: ./.github/workflows/geometry-mesh.yml
     secrets: inherit
     with:
-      doc-build: true
+      doc-build: false #testing
 
   geometry-mesh-fluent:
     uses: ./.github/workflows/geometry-mesh-fluent.yml
     secrets: inherit
     with:
-      doc-build: true
+      doc-build: false #testing
 
   geometry-mechanical-dpf:
     uses: ./.github/workflows/geometry-mechanical-dpf.yml
     secrets: inherit
+    with:
+      doc-build: false #testing
+
+  fluent-mechanical:
+    uses: ./.github/workflows/fluent-mechanical.yml
+    secrets: inherit
     with:
       doc-build: true
 
   compile-docs:
     runs-on: ubuntu-latest
-    needs: [geometry-mesh, geometry-mesh-fluent, geometry-mechanical-dpf]
+    needs: [geometry-mesh, geometry-mesh-fluent, geometry-mechanical-dpf, fluent-mechanical]
     steps:
       - name: Checkout code
         uses: actions/checkout@v4
@@ -66,6 +72,12 @@ jobs:
           name: geometry-mechanical-dpf-docs
           path: doc/
 
+      - name: Download artifacts for fluent-mechanical
+        uses: actions/download-artifact@v4
+        with:
+          name: fluent-mechanical-docs
+          path: doc/
+
       - name: Build the documentation
         run: |
           cd doc

.github/workflows/fluent-mechanical.yml

@@ -0,0 +1,233 @@
+name: Fluent - Mechanical Exhaust Manifold Workflow
+
+on:
+  workflow_dispatch:
+    inputs:
+      doc-build:
+        required: false
+        default: false
+        type: boolean
+        description: 'Whether to build the documentation'
+  workflow_call:
+    inputs:
+      doc-build:
+        required: false
+        default: false
+        type: boolean
+        description: 'Whether to build the documentation'
+  push:
+    branches:
+      - main
+  pull_request:
+    paths:
+      - 'fluent-mechanical/**'
+
+env:
+  MAIN_PYTHON_VERSION: '3.12'
+  FLUENT_DOCKER_IMAGE: 'ghcr.io/ansys/pyfluent'
+  MECHANICAL_DOCKER_IMAGE: 'ghcr.io/ansys/mechanical'
+  DOCKER_MECH_CONTAINER_NAME: mechanical
+  PYMECHANICAL_PORT: 10000
+  ANSYSLMD_LICENSE_FILE: ${{ format('1055@{0}', secrets.LICENSE_SERVER )}}
+  PYANSYS_WORKFLOWS_CI: true
+  ANSYS_RELEASE_FOR_DOCS: 24.2
+  RUN_DOC_BUILD: false
+
+jobs:
+  fluent:
+    name: Fluent
+    runs-on: public-ubuntu-latest-8-cores
+    strategy:
+      fail-fast: false
+      matrix:
+        ansys-release: [24.1, 24.2]
+    steps:
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          sparse-checkout: |
+            fluent-mechanical
+            doc
+
+      - name: Set up Python ${{ env.MAIN_PYTHON_VERSION }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r fluent-mechanical/requirements_${{ matrix.ansys-release }}.txt
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Download Fluent service container
+        run: docker pull ${{ env.FLUENT_DOCKER_IMAGE }}:v${{ matrix.ansys-release }}.0
+
+      - name: Run the Fluent script
+        env:
+          FLUENT_IMAGE_TAG: v${{ matrix.ansys-release }}.0
+        run: |
+          python fluent-mechanical/wf_fm_01_fluent.py
+
+      - name: Store the outputs
+        uses: actions/upload-artifact@v4
+        with:
+          name: fluent-mechanical-workflow-fluent-outputs-${{ matrix.ansys-release }}
+          path: |
+            fluent-mechanical/outputs/htc_temp_mapping_LOW_TEMP.csv
+            fluent-mechanical/outputs/htc_temp_mapping_MEDIUM_TEMP.csv
+            fluent-mechanical/outputs/htc_temp_mapping_HIGH_TEMP.csv
+
+      - name: Stop all containers (if any)
+        run: |
+          if [ -n "$(docker ps -a -q)" ]; then
+              docker rm -f $(docker ps -a -q)
+          fi
+
+      - name: (DOCS) Check if docs should be built
+        if: (github.event_name == 'workflow_dispatch' || github.event_name == 'schedule') && inputs.doc-build
+        run: |
+          echo "Requested to build docs..."
+          if [ "${{ matrix.ansys-release }}" == "${{ env.ANSYS_RELEASE_FOR_DOCS }}" ]; then
+            echo "Building docs"
+            echo "RUN_DOC_BUILD=true" >> $GITHUB_ENV
+          else
+            echo "Not building docs - since not primary release"
+            echo "RUN_DOC_BUILD=false" >> $GITHUB_ENV
+          fi
+
+      - name: (DOCS) Download the docs artifacts
+        uses: actions/download-artifact@v4
+        if: ${{ env.RUN_DOC_BUILD == 'true' }}
+        with:
+          name: fluent-mechanical-docs-stage-fluent
+          path: doc
+
+      - name: (DOCS) Build the documentation (only on ${{ env.ANSYS_RELEASE_FOR_DOCS}})
+        if: ${{ env.RUN_DOC_BUILD == 'true' }}
+        env:
+          FLUENT_IMAGE_TAG: v${{ matrix.ansys-release }}.0
+          BUILD_DOCS_SCRIPT: 'fluent-mechanical/wf_fm_01_fluent.py'
+        run: |
+          cd doc
+          find . -type f -exec sed -i 's|C:\\Users\\ansys\\actions-runner\\_work\\pyansys-workflows\\pyansys-workflows\\doc\\source\\examples\\fluent-mechanical\\images\\|./images/|g' {} +
+          pip install -r requirements.txt
+          make html
+
+      - name: (DOCS) Upload docs artifacts
+        if: ${{ env.RUN_DOC_BUILD == 'true' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: fluent-mechanical-docs-stage-fluent
+          path: |
+            doc/_build/
+            doc/source/examples/fluent-mechanical/
+          overwrite: true
+
+  mechanical:
+    name: Mechanical
+    runs-on: [public-ubuntu-latest-8-cores]
+    needs: fluent
+    strategy:
+      fail-fast: false
+      matrix:
+        ansys-release: [24.1, 24.2]
+    steps:
+
+      - name: Checkout code
+        uses: actions/checkout@v4
+        with:
+          sparse-checkout: |
+            fluent-mechanical
+            doc
+
+      - name: Set up Python ${{ env.MAIN_PYTHON_VERSION }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ env.MAIN_PYTHON_VERSION }}
+
+      - name: Install system dependencies
+        run: |
+          sudo apt-get update
+          sudo apt-get install -y nodejs npm graphviz
+          npm install -g @mermaid-js/mermaid-cli
+
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          python -m venv .venv
+          . .venv/bin/activate
+          pip install -r fluent-mechanical/requirements_${{ matrix.ansys-release }}.txt
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Download (if needed) launch, and validate Mechanical service
+        env:
+          LICENSE_SERVER: ${{ secrets.LICENSE_SERVER }}
+        run: |
+          docker pull ${{ env.MECHANICAL_DOCKER_IMAGE }}
+          docker run --restart always --name ${{ env.DOCKER_MECH_CONTAINER_NAME }} -e ANSYSLMD_LICENSE_FILE=1055@${{ env.LICENSE_SERVER }} -p ${{ env.PYMECHANICAL_PORT }}:10000 ${{ env.MECHANICAL_DOCKER_IMAGE }} > log.txt &
+          grep -q 'WB Initialize Done' <(timeout 60 tail -f log.txt)
+
+      - name: Check out the fluent outputs
+        uses: actions/download-artifact@v4
+        with:
+          name: fluent-mechanical-workflow-fluent-outputs-${{ matrix.ansys-release }}
+          path: fluent-mechanical/outputs
+
+      - name: Run the PyMechanical script
+        env:
+          ANSYS_MECHANICAL_RELEASE: ${{ matrix.ansys-release }}
+        run: |
+          . .venv/bin/activate
+          xvfb-run python fluent-mechanical/wf_fm_02_mechanical.py
+
+      - name: Store the outputs
+        uses: actions/upload-artifact@v4
+        with:
+          name: fluent-mechanical-workflow-mechanical-outputs-${{ matrix.ansys-release }}
+          path: fluent-mechanical/outputs
+
+      - name: (DOCS) Check if docs should be built
+        if: (github.event_name == 'workflow_dispatch' || github.event_name == 'schedule') && inputs.doc-build
+        run: |
+          echo "Requested to build docs..."
+          if [ "${{ matrix.ansys-release }}" = "${{ env.ANSYS_RELEASE_FOR_DOCS }}" ]; then
+            echo "Building docs"
+            echo "RUN_DOC_BUILD=true" >> $GITHUB_ENV
+          else
+            echo "Not building docs - since not primary release"
+            echo "RUN_DOC_BUILD=false" >> $GITHUB_ENV
+          fi
+
+      - name: (DOCS) Build the documentation (only on ${{ env.ANSYS_RELEASE_FOR_DOCS }})
+        if: ${{ env.RUN_DOC_BUILD == 'true' }}
+        env:
+          ANSYS_MECHANICAL_RELEASE: ${{ matrix.ansys-release }}
+          BUILD_DOCS_SCRIPT: 'geometry-mechanical-dpf/wf_gmd_02_mechanical.py'
+        run: |
+          . .venv/bin/activate
+          find . -type f -exec sed -i 's|C:\\Users\\ansys\\actions-runner\\_work\\pyansys-workflows\\pyansys-workflows\\doc\\source\\examples\\fluent-mechanical\\images\\|./images/|g' {} +
+          pip install -r ./doc/requirements.txt
+          xvfb-run make -C doc html
+
+      - name: (DOCS) Upload docs artifacts
+        if: ${{ env.RUN_DOC_BUILD == 'true' }}
+        uses: actions/upload-artifact@v4
+        with:
+          name: fluent-mechanical-docs-stage-mechanical
+          path: |
+            doc/_build/
+            doc/source/examples/fluent-mechanical/

LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2024 ANSYS, Inc. and/or its affiliates.
+Copyright (c) 2024 - 2025 ANSYS, Inc. and/or its affiliates.
 
 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

doc/source/conf.py

@@ -1,4 +1,4 @@
-# Copyright (C) 2024 ANSYS, Inc. and/or its affiliates.
+# Copyright (C) 2024 - 2025 ANSYS, Inc. and/or its affiliates.
 # SPDX-License-Identifier: MIT
 #
 #

fluent-mechanical/README.rst

@@ -0,0 +1,4 @@
+Fluent - Mechanical workflow
+============================
+
+TBD

fluent-mechanical/requirements_24.1.txt

@@ -0,0 +1,3 @@
+ansys-mechanical-core==0.11.10
+ansys-fluent-core==0.26.1
+matplotlib==3.10.0

fluent-mechanical/requirements_24.2.txt

@@ -0,0 +1,3 @@
+ansys-mechanical-core==0.11.10
+ansys-fluent-core==0.26.1
+matplotlib==3.10.0