ansys-fluent-core 0.30.dev3__tar.gz → 0.31.dev0__tar.gz

{ansys_fluent_core-0.30.dev3 → ansys_fluent_core-0.31.dev0}/Makefile

@@ -169,9 +169,6 @@ build-all-docs:
 	@xvfb-run make -C doc html
 	@python doc/modify_html.py
 
-compare-flobject:
-	@python .ci/compare_flobject.py
-
 cleanup-previous-docker-containers:
 	@if [ -n "$(docker ps -a -q)" ]; then \
 		echo "Found running containers"; \

{ansys_fluent_core-0.30.dev3 → ansys_fluent_core-0.31.dev0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: ansys-fluent-core
-Version: 0.30.dev3
+Version: 0.31.dev0
 Summary: PyFluent provides Pythonic access to Ansys Fluent.
 Author-email: "ANSYS, Inc." <pyansys.core@ansys.com>
 Maintainer-email: "ANSYS, Inc." <pyansys.core@ansys.com>
@@ -24,27 +24,27 @@ Requires-Dist: numpy>=1.14.0,<3.0.0
 Requires-Dist: pandas>=1.1.0,<2.3
 Requires-Dist: pyansys-tools-report>=0.8.1
 Requires-Dist: pyyaml>=6.0
-Requires-Dist: Sphinx==7.4.7 ; extra == "docs"
+Requires-Dist: Sphinx==8.1.3 ; extra == "docs"
 Requires-Dist: jupyter_sphinx==0.5.3 ; extra == "docs"
 Requires-Dist: numpydoc==1.8.0 ; extra == "docs"
-Requires-Dist: matplotlib==3.10.0 ; extra == "docs"
-Requires-Dist: ansys-sphinx-theme==1.2.7 ; extra == "docs"
+Requires-Dist: matplotlib==3.10.1 ; extra == "docs"
+Requires-Dist: ansys-sphinx-theme==1.3.2 ; extra == "docs"
 Requires-Dist: pypandoc==1.15 ; extra == "docs"
 Requires-Dist: pytest-sphinx==0.6.3 ; extra == "docs"
 Requires-Dist: sphinx-autobuild==2024.10.3 ; extra == "docs"
-Requires-Dist: sphinx-autodoc-typehints==2.3.0 ; extra == "docs"
+Requires-Dist: sphinx-autodoc-typehints==3.0.1 ; extra == "docs"
 Requires-Dist: sphinx-copybutton==0.5.2 ; extra == "docs"
-Requires-Dist: sphinx-gallery==0.18.0 ; extra == "docs"
+Requires-Dist: sphinx-gallery==0.19.0 ; extra == "docs"
 Requires-Dist: sphinx-notfound-page==1.1.0 ; extra == "docs"
 Requires-Dist: sphinxcontrib-websupport==2.0.0 ; extra == "docs"
 Requires-Dist: sphinxemoji==0.3.1 ; extra == "docs"
-Requires-Dist: sphinx-toggleprompt==0.5.2 ; extra == "docs"
+Requires-Dist: sphinx-toggleprompt==0.6.0 ; extra == "docs"
 Requires-Dist: autodocsumm==0.2.14 ; extra == "docs"
-Requires-Dist: beautifulsoup4==4.13.1 ; extra == "docs"
+Requires-Dist: beautifulsoup4==4.13.3 ; extra == "docs"
 Requires-Dist: openpyxl>=3.1.5 ; extra == "docs"
 Requires-Dist: plotly>=5.22.0 ; extra == "docs"
 Requires-Dist: python-pptx>=0.6.23 ; extra == "docs"
-Requires-Dist: quarto-cli==1.6.39 ; extra == "docs"
+Requires-Dist: quarto-cli==1.6.42 ; extra == "docs"
 Requires-Dist: pdf2image==1.17.0 ; extra == "docs"
 Requires-Dist: seaborn>=0.13.2 ; extra == "docs"
 Requires-Dist: tensorflow>=2.17.0 ; extra == "docs"

ansys_fluent_core-0.31.dev0/doc/changelog.d/changelog_template.jinja

@@ -0,0 +1,22 @@
+{% if sections[""] %}
+
+.. tab-set::
+
+{%+ for category, val in definitions.items() if category in sections[""] %}
+
+  .. tab-item:: {{ definitions[category]['name'] }}
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+{% for text, values in sections[""][category].items() %}
+        * - {{ text }}
+          - {{ values|join(', ') }}
+
+{% endfor %}
+{% endfor %}
+
+{% else %}
+No significant changes.
+{% endif %}

{ansys_fluent_core-0.30.dev3 → ansys_fluent_core-0.31.dev0}/doc/source/changelog.rst

@@ -9,6 +9,102 @@ This document contains the release notes for the project.
 
 .. towncrier release notes start
 
+`0.31.dev0 <https://github.com/ansys/pyfluent/releases/tag/v0.31.dev0>`_ - March 11, 2025
+=========================================================================================
+
+.. tab-set::
+
+
+  .. tab-item:: Maintenance
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - update CHANGELOG for v0.30.0
+          - `#3818 <https://github.com/ansys/pyfluent/pull/3818>`_
+
+
+`0.30.dev4 <https://github.com/ansys/pyfluent/releases/tag/v0.30.dev4>`_ - March 11, 2025
+=========================================================================================
+
+.. tab-set::
+
+
+  .. tab-item:: Maintenance
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - update CHANGELOG for v0.30.dev4
+          - `#3815 <https://github.com/ansys/pyfluent/pull/3815>`_
+
+
+`0.30.dev4 <https://github.com/ansys/pyfluent/releases/tag/v0.30.dev4>`_ - March 10, 2025
+=========================================================================================
+
+.. tab-set::
+
+
+  .. tab-item:: Added
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - Utility to test viability of grpc connection
+          - `#3766 <https://github.com/ansys/pyfluent/pull/3766>`_
+
+        * - Use 'deprecated-version' flag for settings-api classes
+          - `#3802 <https://github.com/ansys/pyfluent/pull/3802>`_
+
+
+  .. tab-item:: Fixed
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - Keep switch-to-meshing as hidden to fix Fluent journal replay.
+          - `#3792 <https://github.com/ansys/pyfluent/pull/3792>`_
+
+        * - Fix python_name issue in runtime python classes
+          - `#3797 <https://github.com/ansys/pyfluent/pull/3797>`_
+
+
+  .. tab-item:: Documentation
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - add solver to example usage command
+          - `#3788 <https://github.com/ansys/pyfluent/pull/3788>`_
+
+        * - Add doc for journal conversion [skip tests]
+          - `#3791 <https://github.com/ansys/pyfluent/pull/3791>`_
+
+        * - Fix built in settings doc [skip tests]
+          - `#3807 <https://github.com/ansys/pyfluent/pull/3807>`_
+
+
+  .. tab-item:: Maintenance
+
+    .. list-table::
+        :header-rows: 0
+        :widths: auto
+
+        * - update CHANGELOG for v0.30.dev3
+          - `#3790 <https://github.com/ansys/pyfluent/pull/3790>`_
+
+        * - Remove compare_flobject.py [skip tests]
+          - `#3793 <https://github.com/ansys/pyfluent/pull/3793>`_
+
+        * - Resolve dependency conflict
+          - `#3800 <https://github.com/ansys/pyfluent/pull/3800>`_
+
+
 `0.30.dev3 <https://github.com/ansys/pyfluent/releases/tag/v0.30.dev3>`_ - 2025-02-28
 =====================================================================================
 

{ansys_fluent_core-0.30.dev3 → ansys_fluent_core-0.31.dev0}/doc/source/contributing/environment_variables.rst

@@ -55,6 +55,8 @@ Following is a list of environment variables that can be set to control various
       - Disables printing of TUI to settings API upgrade advice.
     * - PYFLUENT_TIMEOUT_FORCE_EXIT
       - Enables force exit while exiting a Fluent session and specifies the timeout in seconds.
+    * - PYFLUENT_USE_RUNTIME_PYTHON_CLASSES
+      - Uses runtime Python classes for settings API.
     * - PYFLUENT_WATCHDOG_DEBUG
       - Enables debugging for the PyFluent watchdog process.
     * - PYFLUENT_WATCHDOG_EXCEPTION_ON_ERROR

ansys_fluent_core-0.31.dev0/doc/source/user_guide/convert_journal.rst

@@ -0,0 +1,48 @@
+.. _ref_convert_journal:
+
+Converting TUI Journals to Python
+=================================
+
+The ``topy`` and ``journal_file_names`` arguments in the :func:`launch_fluent() <ansys.fluent.core.launch_fluent>` function is utilized to convert TUI journals into Python journals. 
+This process supports the conversion of multiple TUI journals by passing a list of TUI journal files.
+
+.. code-block:: python
+
+  >>> # Write the converted Python commands from journal.jou to journal.py
+  >>> solver = pyfluent.launch_fluent(journal_file_names="journal.jou", topy=True)
+  >>> solver.exit()
+  >>>
+  >>> # Write the converted Python commands from journal.jou to journal_1.py
+  >>> solver = pyfluent.launch_fluent(journal_file_names="journal.jou", topy="journal_1.py")
+  >>> solver.exit()
+  >>>
+  >>> # Write the converted Python commands from journal_1.jou and then from journal_2.jou to a single file journal_1_journal_2.py
+  >>> solver = pyfluent.launch_fluent(journal_file_names=["journal_1.jou", "journal_2.jou"], topy=True)
+  >>> solver.exit()
+  >>>
+  >>> # Write the converted Python commands from journal_1.jou and then from journal_2.jou to journal_1_2.py
+  >>> solver = pyfluent.launch_fluent(journal_file_names=["journal_1.jou", "journal_2.jou"], topy="journal_1_2.py")
+  >>> solver.exit()
+
+
+Recording a Python Journal
+==========================
+
+Journaling enables seamless recording and playback of Fluent interactions as Python scripts across PyFluent, Fluent, and 
+the Fluent Web UI without requiring adjustments. For additional details, refer to the `Journaling <https://fluent.docs.pyansys.com/version/stable/user_guide/journal.html#journaling>`_ section. 
+Here’s how to record a Fluent Python journal:
+
+.. code-block:: python
+
+  >>> solver.journal.start(file_name="pyfluent_journal.py")
+  <Python code>
+  >>> solver.journal.stop()
+
+
+The specified file is created or overwritten, capturing both scripted and interactive actions as Python code until the ``stop()`` method is invoked.
+
+**Limitations**:
+
+   * TUI calls with settings object equivalents are recorded as method calls on those objects.
+
+   * TUI calls without settings object equivalents are recorded as calls to Python TUI command objects. For more information, see the `Using TUI commands <https://fluent.docs.pyansys.com/version/stable/user_guide/legacy/tui.html#using-tui-commands>`_ section.

{ansys_fluent_core-0.30.dev3 → ansys_fluent_core-0.31.dev0}/doc/source/user_guide/journal.rst

@@ -9,7 +9,7 @@ without making any adjustments. Here's how you can record a Fluent Python journa
 
 .. code-block:: python
 
-  >>> solver.journal.start(file_name="pyfluent-journal.py")
+  >>> solver.journal.start(file_name="pyfluent_journal.py")
   <Python code>
   >>> solver.journal.stop()
 

{ansys_fluent_core-0.30.dev3 → ansys_fluent_core-0.31.dev0}/doc/source/user_guide/legacy/tui.rst

@@ -2,8 +2,8 @@
 
 .. vale Google.Spacing = NO
 
-Use TUI commands
-================
+Using TUI commands
+==================
 
 TUI commands refer to a programming interface that mirrors the Fluent TUI (text
 user interface). There is a TUI command hierarchy defined for each of the two

{ansys_fluent_core-0.30.dev3 → ansys_fluent_core-0.31.dev0}/doc/source/user_guide/solver_settings/solver_settings_contents.rst

@@ -28,7 +28,7 @@ Example usage
 
   >>> import ansys.fluent.core as pyfluent
   >>> solver = pyfluent.launch_fluent()
-  >>> inlet1 = pyfluent.VelocityInlet(settings_source=solver, name="inlet-1")
+  >>> inlet1 = pyfluent.solver.VelocityInlet(settings_source=solver, name="inlet-1")
 
 
 This format provides a more natural way to create and interact with settings objects, 
@@ -132,7 +132,7 @@ and ``NamedObject`` types, the state value is a dictionary. For the
   >>> viscous = pyfluent.solver.Viscous(settings_source=solver)
   >>> viscous.model = 'laminar'
   >>> energy = pyfluent.solver.Energy(settings_source=solver)
-  >>> energy = { 'enabled' : False }
+  >>> energy.enabled = False
   >>> inlet1 = pyfluent.solver.VelocityInlet(settings_source=solver, name="inlet1")
   >>> inlet1.vmag.constant = 14
 

{ansys_fluent_core-0.30.dev3 → ansys_fluent_core-0.31.dev0}/doc/source/user_guide/user_guide_contents.rst

@@ -18,6 +18,7 @@ User guide
    units
    file_transfer
    offline/offline_contents
+   convert_journal
    journal
    log
    usability

{ansys_fluent_core-0.30.dev3 → ansys_fluent_core-0.31.dev0}/pyproject.toml

@@ -48,27 +48,27 @@ tests = [
     "pytest-xdist==3.6.1",
 ]
 docs = [
-    "Sphinx==7.4.7",
+    "Sphinx==8.1.3",
     "jupyter_sphinx==0.5.3",
     "numpydoc==1.8.0",
-    "matplotlib==3.10.0",
-    "ansys-sphinx-theme==1.2.7",
+    "matplotlib==3.10.1",
+    "ansys-sphinx-theme==1.3.2",
     "pypandoc==1.15",
     "pytest-sphinx==0.6.3",
     "sphinx-autobuild==2024.10.3",
-    "sphinx-autodoc-typehints==2.3.0",
+    "sphinx-autodoc-typehints==3.0.1",
     "sphinx-copybutton==0.5.2",
-    "sphinx-gallery==0.18.0",
+    "sphinx-gallery==0.19.0",
     "sphinx-notfound-page==1.1.0",
     "sphinxcontrib-websupport==2.0.0",
     "sphinxemoji==0.3.1",
-    "sphinx-toggleprompt==0.5.2",
+    "sphinx-toggleprompt==0.6.0",
     "autodocsumm==0.2.14",
-    "beautifulsoup4==4.13.1",
+    "beautifulsoup4==4.13.3",
     "openpyxl>=3.1.5",
     "plotly>=5.22.0",
     "python-pptx>=0.6.23",
-    "quarto-cli==1.6.39",
+    "quarto-cli==1.6.42",
     "pdf2image==1.17.0",
     "seaborn>=0.13.2",
     "tensorflow>=2.17.0",

{ansys_fluent_core-0.30.dev3 → ansys_fluent_core-0.31.dev0}/src/ansys/fluent/core/__init__.py

@@ -62,9 +62,9 @@ from ansys.fluent.core.utils import fldoc, get_examples_download_dir
 from ansys.fluent.core.utils.fluent_version import FluentVersion  # noqa: F401
 from ansys.fluent.core.utils.setup_for_fluent import setup_for_fluent  # noqa: F401
 
-__version__ = "0.30.dev3"
+__version__ = "0.31.dev0"
 
-_VERSION_INFO = "Build date: February 28, 2025 09:30 UTC ShaID: 02f2c62"
+_VERSION_INFO = "Build date: March 11, 2025 15:46 UTC ShaID: fee3bcf"
 """
 Global variable indicating the version info of the PyFluent package.
 Build timestamp and commit hash are added to this variable during packaging.