ansys-fluent-core 0.29.dev3__tar.gz → 0.30.dev1__tar.gz

ansys_fluent_core-0.30.dev1/.ci/get_hanging_tests.py

@@ -0,0 +1,72 @@
+"""A script to print the name of the hanging test by parsing the GitHub logs file."""
+
+import argparse
+
+
+def strip_before_tests(input_string):
+    """
+    Strips everything before the 'tests/' in the given string.
+    Parameters
+    ----------
+    input_string: str
+        The original string to process.
+    Returns
+    -------
+        The modified string.
+    """
+    index = input_string.find("tests/")
+    if index != -1:
+        return input_string[index:]
+
+
+def parse_github_log(log_file_path: str) -> str:
+    """
+    Parse GitHub log lines to identify hanging tests.
+
+    Parameters
+    ----------
+    log_file_path: str
+        The path of the log file from GitHub.
+
+    Returns
+    -------
+        Name of the haging tests.
+    """
+    tests = {}
+    hanging_tests = []
+
+    with open(log_file_path, "r", encoding="utf-8") as f:
+        log_lines = f.readlines()
+
+    for line in log_lines:
+        test_name = strip_before_tests(line)
+        if test_name:
+            if tests.get(test_name):
+                tests[test_name] += 1
+            else:
+                tests[test_name] = 1
+
+    for key, value in tests.items():
+        if value != 2:
+            hanging_tests.append(key)
+
+    return hanging_tests
+
+
+if __name__ == "__main__":
+    parser = argparse.ArgumentParser(
+        description="A script to print the name of the hanging test by parsing the GitHub logs file."
+    )
+    parser.add_argument(
+        "-logfile",
+        type=str,
+        help="Path of the log file.",
+    )
+    args = parser.parse_args()
+    hanging_tests = parse_github_log(args.logfile)
+    if hanging_tests:
+        print("\n Hanging tests detected.\n")
+        for test in hanging_tests:
+            print(test)
+    else:
+        print("No hanging tests detected.")

ansys_fluent_core-0.30.dev1/.github/labeler.yml

@@ -0,0 +1,19 @@
+documentation:
+- changed-files:
+  - any-glob-to-any-file: ['doc/source/**/*', 'examples/**/*', 'doc/styles/**/*']
+
+examples:
+- changed-files:
+  - any-glob-to-any-file: ['examples/**/*']
+
+maintenance:
+- changed-files:
+  - any-glob-to-any-file: ['.github/**/*', 'codecov.yml', '.flake8', '.coveragerc', 'pyproject.toml', 'doc/make.bat', 'doc/Makefile']
+
+dependencies:
+- changed-files:
+  - any-glob-to-any-file: ['pyproject.toml']
+
+CI/CD:
+- changed-files:
+  - any-glob-to-any-file: ['docker/**/*', '.github/**/*', '.ci/**/*']

ansys_fluent_core-0.30.dev1/.github/labels.yml

@@ -0,0 +1,168 @@
+#############################################################
+# Reason for this file
+# ====================
+#
+# This file is used by labeler to sync the labels (and their colors),
+# and assign a label to the new pull request.
+# 
+# Check the yml for more info: .github\workflows\label.yml
+#
+
+#############################################################
+# NOTES
+# =====
+#
+# If the labels names are change, the file ``./.github/release.yml`` should be also updated!
+#
+
+#############################################################
+# Main colors (hex)
+# =================
+
+# C0392B # Red: International Orange (Golden Gate Bridge)
+# E67E22 # Orange: Vivid Tangelo
+# F4D03F # Yellow: Sandstorm
+# F9E79F # Light yellow: Medium champagne
+# 27AE60 # Green: Green (Crayola)
+# ffffff # White
+# 2E86C1 # Dark blue: Cyan Cornflower Blue
+# 85C1E9 # Light blue: Aero
+# A569BD # Purple: Rich Lavender
+# 76D7C4 # Light green: Pearl Aqua
+# 000000 # Black
+
+# https://htmlcolorcodes.com/ -- For color picking
+# https://www.color-name.com/ -- For colors to names
+
+#############################################################
+# By priority
+# ===========
+
+- name: BLOCKER
+  description: "No further development until this is fixed"
+  color: C0392B
+
+- name: critical priority
+  description: "This issue affects almost all users"
+  color: E67E22
+
+- name: major priority
+  description: "This issue affects some users"
+  color: F4D03F
+
+- name: minor priority
+  description: "This issue affects few users"
+  color: F9E79F
+
+- name: future
+  description: "To work on it in the future, since it can be delayed"
+  color: 27AE60
+
+- name: won't fix
+  description: "For different reasons, this won't be fixed"
+  color: ffffff
+
+#############################################################
+# By Category
+# ===========
+
+- name: bug
+  description: "Issue, problem or error in PyFluent"
+  color: E67E22
+
+- name: new feature
+  description: "Request or proposal for a new feature"
+  color: 85C1E9
+  
+- name: enhancement
+  description: "Improve any current implemented feature"
+  color: 85C1E9
+
+- name: examples
+  description: "Publishing PyFluent examples"
+  color: A569BD
+
+- name: documentation
+  description: "Documentation related (improving, adding, etc)"
+  color: A569BD
+
+- name: maintenance
+  description: "General maintenance of the repo (libraries, cicd, etc)"
+  color: 76D7C4
+
+- name: discussion
+  description: ""
+  color: 76D7C4
+
+- name: question
+  description: ""
+  color: 76D7C4
+
+#############################################################
+# Issue management
+# ================
+
+- name: duplicate
+  description: "Duplicated issue"
+  color: E67E22
+
+- name: good first issue
+  description: "Best way to start working on PyFluent development"
+  color: 27AE60
+
+- name: help wanted!
+  description: "Tell the developers you need help or guidance"
+  color: F4D03F
+
+- name: stale
+  description: "Stale issue likely to be closed soon"
+  color: E67E22
+
+- name: waiting doc review
+  description: "This PR is waiting for its documentation to be reviewed."
+  color: 27AE60
+
+#############################################################
+# For repo maintenance
+# ====================
+# (Only maintainers should use them)
+
+- name: Settings API
+  description: "Related to the settings API"
+  color: C0392B
+
+- name: Fluent
+  description: "Related to Fluent"
+  color: E67E22
+
+- name: Datamodel API
+  description: "Related to the datamodel API"
+  color: F4D03F
+
+- name: Fluent
+  description: "Requires changes in Fluent"
+  color: F9E79F
+
+- name: refactoring
+  description: "Related to refactoring"
+  color: 27AE60
+
+- name: testing
+  description: "Related to testing"
+  color: ffffff
+
+- name: ci_failed
+  description: "Related to CI failures"
+  color: 2E86C1
+
+- name: flobject
+  description: "Related to Flobject"
+  color: 85C1E9
+
+- name: design
+  description: "Related to design"
+  color: A569BD
+
+- name: epic
+  description: "Related to an epic issue"
+  color: 76D7C4

{ansys_fluent_core-0.29.dev3 → ansys_fluent_core-0.30.dev1}/.github/workflows/ci.yml

@@ -19,12 +19,6 @@ concurrency:
   cancel-in-progress: true
 
 env:
-  # Following env vars when changed will "reset" the mentioned cache,
-  # by changing the cache file name. It is rendered as ...-v%RESET_XXX%-...
-  # You should go up in number, if you go down (or repeat a previous value)
-  # you might end up reusing a previous cache if it haven't been deleted already.
-  # It applies 7 days retention policy by default.
-  RESET_EXAMPLES_CACHE: 7
   API_CODE_CACHE: 3
   DOCUMENTATION_CNAME: 'fluent.docs.pyansys.com'
   PACKAGE_NAME: 'ansys-fluent-core'
@@ -40,6 +34,20 @@ env:
 
 jobs:
 
+  update-changelog:
+    name: "Update CHANGELOG (on release)"
+    if: github.event_name == 'push' && contains(github.ref, 'refs/tags')
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: ansys/actions/doc-deploy-changelog@v8
+        with:
+          bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+          bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
+          token: ${{ secrets.PYANSYS_CI_BOT_TOKEN }}
+
   docs-style:
     name: Documentation Style Check
     runs-on: ubuntu-latest
@@ -179,14 +187,6 @@ jobs:
           rm -rf dist
           make install > /dev/null
 
-      - name: Cache examples
-        uses: actions/cache@v4
-        with:
-          path: doc/source/examples
-          key: Examples-v${{ env.RESET_EXAMPLES_CACHE }}-${{ steps.version.outputs.PYFLUENT_VERSION }}-${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}-${{ hashFiles('examples/**', 'doc/source/conf.py') }}
-          restore-keys: |
-            Examples-v${{ env.RESET_EXAMPLES_CACHE }}-${{ steps.version.outputs.PYFLUENT_VERSION }}-${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}
-
       - name: Build Source Documentation
         run: |
           pip install -r requirements/requirements_build.txt
@@ -194,7 +194,6 @@ jobs:
           make build-doc-source
         env:
           FLUENT_IMAGE_TAG: ${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}
-          PYFLUENT_DOC_SKIP_CHEATSHEET: 1
 
       - name: Zip HTML Documentation before upload
         run: |
@@ -474,7 +473,7 @@ jobs:
 
       - name: Check package
         run: |
-          pip install twine==5.0.0
+          pip install twine
           twine check dist/*
 
       - name: Upload package
@@ -573,7 +572,7 @@ jobs:
   release:
     name: Release
     if: github.event_name == 'push' && startsWith(github.ref, 'refs/tags/v')
-    needs: test
+    needs: [test, update-changelog]
     runs-on: ubuntu-latest
     steps:
       - name: Set up Python
@@ -588,7 +587,7 @@ jobs:
 
       - name: Upload to Private PyPi
         run: |
-          pip install twine==5.0.0
+          pip install twine
           python -m twine upload --skip-existing ./**/*.whl
           python -m twine upload --skip-existing ./**/*.tar.gz
         env:
@@ -598,7 +597,7 @@ jobs:
 
       - name: Upload to Public PyPi
         run: |
-          pip install twine==5.0.0
+          pip install twine
           twine upload --skip-existing ./**/*.whl
           python -m twine upload --skip-existing ./**/*.tar.gz
         env:

{ansys_fluent_core-0.29.dev3 → ansys_fluent_core-0.30.dev1}/.github/workflows/doc-build-dev-nightly.yml

@@ -7,7 +7,7 @@ on:
 
 env:
   DOCUMENTATION_CNAME: 'fluent.docs.pyansys.com'
-  DOC_DEPLOYMENT_IMAGE_TAG: v25.1.0
+  DOC_DEPLOYMENT_IMAGE_TAG: v25.2.0
   ANSYSLMD_LICENSE_FILE: ${{ format('1055@{0}', secrets.LICENSE_SERVER) }}
   PYFLUENT_TIMEOUT_FORCE_EXIT: 30
   PYFLUENT_LAUNCH_CONTAINER: 1
@@ -59,6 +59,16 @@ jobs:
           rm -rf dist
           make install > /dev/null
 
+      - name: Execute examples
+        run: |
+          python examples/00-fluent/exhaust_system_settings_api.py
+          python examples/00-fluent/external_compressible_flow.py
+          python examples/00-fluent/mixing_elbow_settings_api.py
+          python examples/00-fluent/modeling_cavitation.py
+          python examples/00-fluent/species_transport.py
+        env:
+          FLUENT_IMAGE_TAG: ${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}
+
       - name: Build All Documentation
         run: |
           pip install -r requirements/requirements_build.txt
@@ -66,6 +76,7 @@ jobs:
           make build-all-docs
         env:
           FLUENT_IMAGE_TAG: ${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}
+          BUILD_ALL_DOCS: 1
 
       - name: Zip HTML Documentation before upload
         run: |

{ansys_fluent_core-0.29.dev3 → ansys_fluent_core-0.30.dev1}/.github/workflows/doc-build-release.yml

@@ -63,6 +63,7 @@ jobs:
           make build-all-docs
         env:
           FLUENT_IMAGE_TAG: ${{ env.DOC_DEPLOYMENT_IMAGE_TAG }}
+          BUILD_ALL_DOCS: 1
 
       - name: Zip HTML Documentation before upload
         run: |

ansys_fluent_core-0.30.dev1/.github/workflows/execute-examples-weekly.yml

@@ -0,0 +1,114 @@
+name: Execute Examples Weekly
+
+on:
+  schedule:  # UTC at 0400 on Saturday
+    - cron:  '0 4 * * SAT'
+  workflow_dispatch:
+
+env:
+  ANSYSLMD_LICENSE_FILE: ${{ format('1055@{0}', secrets.LICENSE_SERVER) }}
+  PYFLUENT_TIMEOUT_FORCE_EXIT: 30
+  PYFLUENT_LAUNCH_CONTAINER: 1
+  PYFLUENT_LOGGING: 'DEBUG'
+  PYFLUENT_WATCHDOG_DEBUG: 'OFF'
+  PYFLUENT_HIDE_LOG_SECRETS: 1
+  MAIN_PYTHON_VERSION: '3.12'
+  PYFLUENT_SKIP_API_UPGRADE_ADVICE: 1
+  PYFLUENT_CONTAINER_MOUNT_SOURCE: "/home/ansys/Downloads/ansys_fluent_core_examples"
+
+jobs:
+
+  execute_examples:
+    name: Build
+    runs-on: [public-ubuntu-latest-8-cores]
+    strategy:
+      fail-fast: false
+      matrix:
+        include:
+          - image-tag: v25.1.0
+            version: 251
+          - image-tag: v25.2.0
+            version: 252
+
+    steps:
+      - uses: actions/checkout@v4
+
+      - name: Setup Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: 3.12
+
+      - name: Cache pip
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: Python-${{ runner.os }}-${{ matrix.python-version }}-${{ hashFiles('pyproject.toml') }}
+          restore-keys: |
+            Python-${{ runner.os }}-${{ matrix.python-version }}
+
+      - name: Add version information
+        run: make version-info
+
+      - name: Install pyfluent
+        run: make install
+
+      - name: Retrieve PyFluent version
+        run: |
+          echo "PYFLUENT_VERSION=$(python -c "from ansys.fluent.core import __version__; print(); print(__version__)" | tail -1)" >> $GITHUB_OUTPUT
+          echo "PYFLUENT version is: $(python -c "from ansys.fluent.core import __version__; print(); print(__version__)" | tail -1)"
+        id: version
+
+      - name: Login to GitHub Container Registry
+        uses: docker/login-action@v3
+        with:
+          registry: ghcr.io
+          username: ansys-bot
+          password: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: Pull Fluent docker image
+        run: make docker-pull
+        env:
+          FLUENT_IMAGE_TAG: ${{ matrix.image-tag }}
+
+      - name: Run API codegen
+        run: |
+          sudo mkdir -p /home/ansys/Downloads/ansys_fluent_core_examples
+          sudo chmod a+rwx /home/ansys/Downloads/ansys_fluent_core_examples
+          pip install ansys-fluent-visualization==0.18.dev0
+          make api-codegen
+        env:
+          FLUENT_IMAGE_TAG: ${{ matrix.image-tag }}
+
+      - name: Print Fluent version info
+        run: |
+          cat src/ansys/fluent/core/generated/fluent_version_${{ matrix.version }}.py
+
+      - name: Install again after codegen
+        run: |
+          rm -rf dist
+          make install > /dev/null
+
+      - name: Execute Examples
+        run: |
+            echo "Executing examples"
+            sudo rm -rf /home/ansys/Downloads/ansys_fluent_core_examples/*
+            python examples/00-fluent/ahmed_body_workflow.py
+            python examples/00-fluent/brake.py
+            python examples/00-fluent/conjugate_heat_transfer.py
+            python examples/00-fluent/DOE_ML.py
+            python examples/00-fluent/exhaust_system_settings_api.py
+            python examples/00-fluent/external_compressible_flow.py
+            python examples/00-fluent/lunar_lander_thermal.py
+            python examples/00-fluent/mixing_elbow_settings_api.py
+            python examples/00-fluent/modeling_ablation.py
+            python examples/00-fluent/modeling_cavitation.py
+            python examples/00-fluent/parametric_static_mixer_1.py
+            python examples/00-fluent/radiation_headlamp.py
+            python examples/00-fluent/species_transport.py
+            python examples/00-fluent/tyler_sofrin_modes.py
+        env:
+          FLUENT_IMAGE_TAG: ${{ matrix.image-tag }}
+
+      - name: Cleanup previous docker containers
+        if: always()
+        run: make cleanup-previous-docker-containers

ansys_fluent_core-0.30.dev1/.github/workflows/label.yml

@@ -0,0 +1,136 @@
+name: "Pull Request Labeler"
+on:
+  pull_request:
+    # opened, reopened, and synchronize are default for pull_request
+    # edited - when PR title or body is changed
+    # labeled - when labels are added to PR
+    types: [opened, reopened, synchronize, edited, labeled]
+  push:
+    branches: [ main ]
+    paths:
+      - '../labels.yml'
+
+concurrency:
+  group: ${{ github.workflow }}-${{ github.ref }}
+  cancel-in-progress: true
+
+jobs:
+
+  label-syncer:
+    # Sync the labels name, colours with the file ``labels.yml``
+    name: Syncer
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4.2.2
+      - uses: micnncim/action-label-syncer@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+
+  labeler:
+    name: Set labels
+    needs: [label-syncer]
+    permissions:
+      contents: read
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+
+    # Label based on modified files
+    - name: Label based on changed files
+      uses: actions/labeler@v5
+      with:
+        repo-token: "${{ secrets.GITHUB_TOKEN }}"
+        sync-labels: true
+
+    # Label based on branch name
+    - uses: actions-ecosystem/action-add-labels@v1
+      if: |
+        startsWith(github.event.pull_request.title, 'fix') || 
+        startsWith(github.event.pull_request.title, 'bug') ||
+        startsWith(github.event.pull_request.title, 'patch')
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN}}
+        labels: bug
+
+    - uses: actions-ecosystem/action-add-labels@v1
+      if: |
+        startsWith(github.event.pull_request.title, 'feat')
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN}}
+        labels: new feature
+
+    - uses: actions-ecosystem/action-add-labels@v1
+      if: |
+        startsWith(github.event.pull_request.title, 'style') ||
+        startsWith(github.event.pull_request.title, 'refactor') ||
+        startsWith(github.event.pull_request.title, 'perf') ||
+        startsWith(github.event.pull_request.title, 'test') ||
+        startsWith(github.event.pull_request.title, 'chore')
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN}}
+        labels: enhancement
+
+    - uses: actions-ecosystem/action-add-labels@v1
+      if: |
+        startsWith(github.event.pull_request.title, 'build') ||
+        startsWith(github.event.pull_request.title, 'revert') ||
+        startsWith(github.event.pull_request.title, 'maint')
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN}}
+        labels: maintenance
+      
+    - uses: actions-ecosystem/action-add-labels@v1
+      if: |
+        startsWith(github.event.pull_request.title, 'doc') || 
+        startsWith(github.event.pull_request.title, 'docs')
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN}}
+        labels: documentation
+
+    - uses: actions-ecosystem/action-add-labels@v1
+      if: |
+        startsWith(github.event.pull_request.title, 'docker') ||
+        startsWith(github.event.pull_request.title, 'no-ci') ||
+        startsWith(github.event.pull_request.title, 'ci')
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN}}
+        labels: CI/CD
+
+  commenter:
+    runs-on: ubuntu-latest
+    needs: [labeler]
+    permissions:
+      pull-requests: write
+    steps:
+    - name: Suggest to add labels
+      uses: peter-evans/create-or-update-comment@v4
+      # Execute only when no labels have been applied to the pull request
+      if: toJSON(github.event.pull_request.labels.*.name) == '{}' # Empty labels
+      with:
+        token: ${{ secrets.GITHUB_TOKEN }}
+        issue-number: ${{ github.event.pull_request.number }}
+        body: |
+          Please add one of the following labels to add this contribution to the Release Notes :point_down:
+          - [bug](https://github.com/ansys/pyfluent/pulls?q=label%3Abug+)
+          - [new feature](https://github.com/ansys/pyfluent/pulls?q=label%3A"new%20feature"+)
+          - [enhancement](https://github.com/ansys/pyfluent/pulls?q=label%3Aenhancement+)
+          - [documentation](https://github.com/ansys/pyfluent/pulls?q=label%3Adocumentation+)
+          - [examples](https://github.com/ansys/pyfluent/pulls?q=label%3Aexamples+)
+          - [maintenance](https://github.com/ansys/pyfluent/pulls?q=label%3Amaintenance+)
+          - [CI/CD](https://github.com/ansys/pyfluent/pulls?q=label%3Aci%2Fcd+)
+
+  changelog-fragment:
+    name: "Create changelog fragment"
+    needs: [labeler]
+    permissions:
+      contents: write
+      pull-requests: write
+    runs-on: ubuntu-latest
+    steps:
+    - uses: ansys/actions/doc-changelog@v8
+      with:
+        bot-user: ${{ secrets.PYANSYS_CI_BOT_USERNAME }}
+        bot-email: ${{ secrets.PYANSYS_CI_BOT_EMAIL }}
+        token: ${{ secrets.GITHUB_TOKEN }}
+        use-conventional-commits: true
+        use-default-towncrier-config: true

{ansys_fluent_core-0.29.dev3 → ansys_fluent_core-0.30.dev1}/.github/workflows/test-run-old-versions-weekly.yml

@@ -133,7 +133,7 @@ jobs:
 
       - name: Check package
         run: |
-          pip install twine==5.0.0
+          pip install twine
           twine check dist/*
 
       - name: Upload package

{ansys_fluent_core-0.29.dev3 → ansys_fluent_core-0.30.dev1}/.github/workflows/test-run-wo-codegen-weekly.yml

@@ -49,7 +49,7 @@ jobs:
 
       - name: Check package
         run: |
-          pip install twine==5.0.0
+          pip install twine
           twine check dist/*
 
       - name: Upload package

{ansys_fluent_core-0.29.dev3 → ansys_fluent_core-0.30.dev1}/.pre-commit-config.yaml

@@ -17,7 +17,7 @@ repos:
     ]
 
 - repo: https://github.com/pycqa/isort
-  rev: 5.13.2
+  rev: 6.0.0
   hooks:
   - id: isort
 
@@ -84,3 +84,10 @@ repos:
     - id: conventional-pre-commit
       stages: [commit-msg]
       args: []
+
+- repo: https://github.com/ansys/pre-commit-hooks
+  rev: v0.5.1
+  hooks:
+    - id: add-license-headers
+      args:
+      - --start_year=2021

ansys_fluent_core-0.30.dev1/CHANGELOG.md

@@ -0,0 +1,7 @@
+# CHANGELOG
+
+This project uses [towncrier](https://towncrier.readthedocs.io/) to generate changelogs. 
+
+For more information, see the [raw release notes](doc/source/changelog.rst).
+
+[Published release notes](https://fluent.docs.pyansys.com/version/stable/changelog.html) can be found in the online documentation.