Skip to content

Commit dc4f02f

Browse files
authored
chore: Doc/CI update for 25.1 release (#3641)
1 parent 726c95e commit dc4f02f

File tree

18 files changed

+42
-52
lines changed

18 files changed

+42
-52
lines changed

.github/workflows/ci.yml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -563,8 +563,8 @@ jobs:
563563
if: always()
564564
run: make cleanup-previous-docker-containers
565565

566-
- name: Upload 24.2 Coverage Artifacts
567-
if: matrix.image-tag == 'v24.2.0'
566+
- name: Upload 25.1 Coverage Artifacts
567+
if: matrix.image-tag == 'v25.1.0'
568568
uses: actions/upload-artifact@v4
569569
with:
570570
name: coverage_report

.github/workflows/test-run-nightly.yml

Lines changed: 14 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,8 @@ env:
1313
PYFLUENT_WATCHDOG_DEBUG: 'OFF'
1414
PYFLUENT_HIDE_LOG_SECRETS: 1
1515
MAIN_PYTHON_VERSION: '3.10'
16+
FLUENT_IMAGE_TAG: v25.1.0
17+
FLUENT_VERSION: 251
1618

1719
jobs:
1820
test:
@@ -55,56 +57,44 @@ jobs:
5557
username: ansys-bot
5658
password: ${{ secrets.GITHUB_TOKEN }}
5759

58-
- name: Pull 24.2 Fluent docker image
60+
- name: Pull Fluent docker image
5961
run: make docker-pull
6062
env:
61-
FLUENT_IMAGE_TAG: v24.2.0
63+
FLUENT_IMAGE_TAG: ${{ env.FLUENT_IMAGE_TAG }}
6264

63-
- name: Run 24.2 API codegen
65+
- name: Run API codegen
6466
run: make api-codegen
6567
env:
66-
FLUENT_IMAGE_TAG: v24.2.0
68+
FLUENT_IMAGE_TAG: ${{ env.FLUENT_IMAGE_TAG }}
6769

68-
- name: Pull 25.1 Fluent docker image
69-
run: make docker-pull
70-
env:
71-
FLUENT_IMAGE_TAG: v25.1.0
72-
73-
# The version-independent built-in settings classes are generated only with Fluent 25.1
74-
# which are required for the unit tests
75-
- name: Run 25.1 API codegen
76-
run: make api-codegen
77-
env:
78-
FLUENT_IMAGE_TAG: v25.1.0
79-
80-
- name: Print 24.2 Fluent version info
70+
- name: Print Fluent version info
8171
run: |
82-
cat src/ansys/fluent/core/generated/fluent_version_242.py
83-
python -c "from ansys.fluent.core.generated.solver.settings_242 import SHASH; print(f'SETTINGS_HASH = {SHASH}')"
72+
cat src/ansys/fluent/core/generated/fluent_version_${{ env.FLUENT_VERSION }}.py
73+
python -c "from ansys.fluent.core.generated.solver.settings_${{ env.FLUENT_VERSION }} import SHASH; print(f'SETTINGS_HASH = {SHASH}')"
8474
8575
- name: Install again after codegen
8676
run: |
8777
rm -rf dist
8878
make install > /dev/null
8979
90-
- name: 24.2 Unit Testing
80+
- name: Unit Testing
9181
run: |
9282
make install-test
93-
make unittest-all-242
83+
make unittest-all-${{ env.FLUENT_VERSION }}
9484
env:
95-
FLUENT_IMAGE_TAG: v24.2.0
85+
FLUENT_IMAGE_TAG: ${{ env.FLUENT_IMAGE_TAG }}
9686

9787
- name: Cleanup previous docker containers
9888
if: always()
9989
run: make cleanup-previous-docker-containers
10090

101-
- name: Upload 24.2 Coverage Results to Codecov
91+
- name: Upload Coverage Results to Codecov
10292
uses: codecov/codecov-action@v5
10393
with:
10494
root_dir: ${{ github.workspace }}
10595
name: cov_xml.xml
10696

107-
- name: Upload 24.2 Coverage Artifacts
97+
- name: Upload Coverage Artifacts
10898
uses: actions/upload-artifact@v4
10999
with:
110100
name: coverage_report

doc/source/contributing/index.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -33,9 +33,9 @@ To run the PyFluent unit tests, execute the following command in the root
3333
.. code:: console
3434
3535
pip install ansys-fluent-core[tests]
36-
python -m pytest -n 4 --fluent-version=24.2
36+
python -m pytest -n 4 --fluent-version=25.1
3737
38-
You can change the Fluent version by replacing ``24.2`` with the version you want to test.
38+
You can change the Fluent version by replacing ``25.1`` with the version you want to test.
3939

4040
Build documentation
4141
-------------------

doc/source/getting_started/faqs.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -200,10 +200,10 @@ increasing order of precedence:
200200

201201
#. ``AWP_ROOT<ver>`` environment variable, which is configured on Windows system
202202
when Fluent is installed, where ``<ver>`` is the Fluent release number such
203-
as ``242`` for release 2024 R2. PyFluent automatically uses this environment
203+
as ``251`` for release 2025 R1. PyFluent automatically uses this environment
204204
variable to locate the latest Fluent installation. On Linux systems configure
205205
``AWP_ROOT<ver>`` to point to the absolute path of an Ansys installation such
206-
as ``/apps/ansys_inc/v242``.
206+
as ``/apps/ansys_inc/v251``.
207207

208208

209209
How do you disable PyFluent warnings shown in the console?

doc/source/getting_started/installation.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -86,16 +86,16 @@ All versions of PyFluent support Fluent 2022 R2 and later.
8686

8787
PyFluent uses an environment variable to locate your Ansys installation.
8888

89-
On Windows, the Ansys installer sets the environment variable. For instance, the Ansys 2024R2
90-
installer sets the ``AWP_ROOT242`` environment variable to point to ``C:\Program Files\ANSYS Inc\v242``
89+
On Windows, the Ansys installer sets the environment variable. For instance, the Ansys 2025 R1
90+
installer sets the ``AWP_ROOT251`` environment variable to point to ``C:\Program Files\ANSYS Inc\v251``
9191
if you accept the default installation location.
9292

9393
**On Linux, the environment variable is not set automatically.** It can be set for the
9494
current user in the current shell session as follows:
9595

9696
.. code:: console
9797
98-
export AWP_ROOT242=/usr/ansys_inc/v242
98+
export AWP_ROOT251=/usr/ansys_inc/v251
9999
100100
For this variable to persist between different shell sessions for the current user, the same
101101
export command can instead be added to the user's ``~/.profile`` file.

doc/source/user_guide/index.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -35,7 +35,7 @@ A simple example
3535
.. code:: python
3636
3737
>>> import ansys.fluent.core as pyfluent
38-
>>> meshing = pyfluent.launch_fluent(mode=pyfluent.FluentMode.MESHING, product_version=pyfluent.FluentVersion.v242)
38+
>>> meshing = pyfluent.launch_fluent(mode=pyfluent.FluentMode.MESHING, product_version=pyfluent.FluentVersion.v251)
3939
>>> watertight = meshing.watertight()
4040
>>> watertight.import_geometry.file_name = pyfluent.examples.download_file("mixing_elbow.pmdb","pyfluent/mixing_elbow")
4141
>>> watertight.import_geometry()

doc/source/user_guide/session/launching_ansys_fluent.rst

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -161,7 +161,7 @@ scheduler using the ``sbatch`` command:
161161
#
162162
# Activate your favorite Python environment
163163
#
164-
export AWP_ROOT242=/apps/ansys_inc/v242
164+
export AWP_ROOT251=/apps/ansys_inc/v251
165165
. ./venv/bin/activate
166166
#
167167
# Run a PyFluent script
@@ -173,7 +173,7 @@ Here are a few notes about this example:
173173

174174
- Eight machines with a total of 32 cores are requested. Fluent is started with
175175
the appropriate command line arguments passed to ``-t`` and ``-cnf``.
176-
- The variable ``AWP_ROOT242`` is configured so that PyFluent can find
176+
- The variable ``AWP_ROOT251`` is configured so that PyFluent can find
177177
the Fluent installation.
178178
- The code assumes that a Python virtual environment was pre-configured with
179179
PyFluent installed before the job script is submitted to Slurm. You could

examples/00-fluent/conjugate_heat_transfer.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,7 @@
6161
# ================================================================
6262

6363
meshing = pyfluent.launch_fluent(
64-
product_version="24.2.0",
64+
product_version="25.1.0",
6565
mode="meshing",
6666
dimension=3,
6767
precision="double",

examples/00-fluent/lunar_lander_thermal.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -243,7 +243,7 @@ def get_surf_mean_temp(
243243
processor_count=12,
244244
mode="solver",
245245
cwd=pyfluent.EXAMPLES_PATH,
246-
product_version="24.2.0",
246+
product_version="25.1.0",
247247
)
248248
print(solver.get_fluent_version())
249249

examples/00-fluent/modeling_ablation.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -86,7 +86,7 @@
8686
# ==================================================================================
8787

8888
solver = pyfluent.launch_fluent(
89-
product_version="24.2.0",
89+
product_version="25.1.0",
9090
dimension=3,
9191
precision="double",
9292
processor_count=4,

0 commit comments

Comments
 (0)