Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
28 changes: 21 additions & 7 deletions README.rst
Original file line number Diff line number Diff line change
@@ -1,15 +1,26 @@
PyFluent
========
|pyansys| |GH-CI| |MIT|
|pyansys| |pypi| |GH-CI| |MIT| |black|

.. |pyansys| image:: https://img.shields.io/badge/Py-Ansys-ffc107.svg?logo=data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAIAAACQkWg2AAABDklEQVQ4jWNgoDfg5mD8vE7q/3bpVyskbW0sMRUwofHD7Dh5OBkZGBgW7/3W2tZpa2tLQEOyOzeEsfumlK2tbVpaGj4N6jIs1lpsDAwMJ278sveMY2BgCA0NFRISwqkhyQ1q/Nyd3zg4OBgYGNjZ2ePi4rB5loGBhZnhxTLJ/9ulv26Q4uVk1NXV/f///////69du4Zdg78lx//t0v+3S88rFISInD59GqIH2esIJ8G9O2/XVwhjzpw5EAam1xkkBJn/bJX+v1365hxxuCAfH9+3b9/+////48cPuNehNsS7cDEzMTAwMMzb+Q2u4dOnT2vWrMHu9ZtzxP9vl/69RVpCkBlZ3N7enoDXBwEAAA+YYitOilMVAAAAAElFTkSuQmCC
:target: https://docs.pyansys.com/
:alt: PyAnsys

.. |pypi| image:: https://img.shields.io/pypi/v/ansys-fluent-core.svg?logo=python&logoColor=white
:target: https://pypi.org/project/ansys-fluent-core
:alt: PyPI

.. |GH-CI| image:: https://github.com/pyansys/pyfluent/actions/workflows/ci.yml/badge.svg
:target: https://github.com/pyansys/pyfluent/actions/workflows/ci.yml
:alt: GH-CI

.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg
:target: https://opensource.org/licenses/MIT
:alt: MIT

.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat
:target: https://github.com/psf/black
:alt: Black

Overview
--------
Expand Down Expand Up @@ -50,13 +61,13 @@ with:
git clone https://github.com/pyansys/pyfluent.git
cd pyfluent
pip install pip -U
pip install install_data/ansys_api_fluent-0.1.0-py3-none-any.whl
pip install install_data/ansys_api_fluent-0.1.0-py3-none-any.whl # till public release
pip install -e .
python codegen/allapigen.py # Generates the API files, requires Fluent

Dependencies
------------
You will need a locally installed licenced copy of ANSYS to run Fluent, with the
You will need a locally installed licensed copy of ANSYS to run Fluent, with the
first supported version being Ansys 2022 R2.

Getting Started
Expand Down Expand Up @@ -89,10 +100,13 @@ You can run Fluent TUI commands using the ``session.tui`` interface:
session.solver.tui.solve.initialize.initialize_flow()
session.solver.tui.solve.dual_time_iterate(2, 3)

In addition to all TUI commands being available there are the `ansys-fluent-parametric <https://github.com/pyansys/pyfluent-parametric>`_ and
`ansys-fluent-visualization <https://github.com/pyansys/pyfluent-visualization>`_ packages. The ``ansys-fluent-parametric`` package provides access to Fluent's
design point capability and the ``ansys-fluent-visualization`` package provides integrations with both
``pyvista`` and ``matplotlib``.
In addition to all TUI commands being available there are the
`PyFluent Parametric <https://fluentparametric.docs.pyansys.com/>`_ and
`PyFluent Visualization <https://fluentvisualization.docs.pyansys.com/>`_ packages.
The PyFluent Parametric package provides access to Fluent's parametric workflows and
the PyFluent Visualization package provides post-processing and visualization
capabilities using `pyvista <https://docs.pyvista.org/>`_ and
`matplotlib <https://matplotlib.org/>`_.

License and Acknowledgments
---------------------------
Expand Down
6 changes: 3 additions & 3 deletions doc/source/contributing.rst
Original file line number Diff line number Diff line change
Expand Up @@ -4,10 +4,10 @@
Contributing
============
Overall guidance on contributing to a PyAnsys library appears in the
`Contributing <https://dev.docs.pyansys.com/overview/contributing.html>`_ topic
`Contributing <https://dev.docs.pyansys.com/how-to/contributing.html>`_ topic
in the *PyAnsys Developer's Guide*. Ensure that you are thoroughly familiar with
it and all `Guidelines and Best Practices
<https://dev.docs.pyansys.com/guidelines/index.html>`_ before attempting to
it and `Coding Style
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There doesn't seem to be a Guidelines and Best Practices section at present. Coding Style is the closest I could find.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, they moved all the guidelines to the "How-To" instead.

<https://dev.docs.pyansys.com/coding-style/index.html#coding-style>`_ before attempting to
contribute to PyFluent.

The following contribution information is specific to PyFluent.
Expand Down
2 changes: 1 addition & 1 deletion doc/source/getting_started/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
===============
Getting Started
===============
To run PyFluent, you must have a local licenced copy of Ansys Fluent.
To run PyFluent, you must have a local licensed copy of Ansys Fluent.
PyFluent supports Ansys Fluent versions 2022 R2 or newer.

Visit `Ansys <https://www.ansys.com/>`_ for more information on
Expand Down
31 changes: 0 additions & 31 deletions examples/00-fluent/exhaust_system.py
Original file line number Diff line number Diff line change
Expand Up @@ -43,11 +43,6 @@
import ansys.fluent.core as pyfluent
from ansys.fluent.core import examples

# from ansys.fluent.post import set_config
# from ansys.fluent.post.pyvista import Graphics

# set_config(blocking=True, set_view_on_display="isometric")

import_filename = examples.download_file(
"exhaust_system.fmd", "pyfluent/exhaust_system"
)
Expand Down Expand Up @@ -594,7 +589,6 @@
"()",
"quit",
)
# session.solver.tui.display.objects.display("pathlines-1")

###############################################################################
# Create an iso-surface through the manifold geometry.
Expand Down Expand Up @@ -630,7 +624,6 @@
"quit",
"quit",
)
# session.solver.tui.display.objects.display("contour-velocity")

session.solver.tui.display.objects.create(
"mesh", "mesh-1", "surfaces-list", "*", "()", "quit"
Expand All @@ -654,30 +647,6 @@
"quit",
"quit",
)
# session.solver.tui.display.objects.display("scene-1")

###############################################################################
# Mesh display using PyVista

# graphics_session = Graphics(session)
# mesh_1 = graphics_session.Meshes["mesh-1"]
# mesh_1.show_edges = True
# mesh_1.surfaces_list = [
# "inlet-1",
# "inlet-2",
# "inlet-3",
# "outlet-1",
# "flow-pipe",
# "main.1",
# "object1.1",
# "object2.1",
# "outpipe3.1",
# ]

# mesh_1.display()
###############################################################################
# Save case, data.
# session.solver.tui.file.write_case_data("exhaust_system.cas.h5")

#########################################################################
# Close Fluent
Expand Down
3 changes: 0 additions & 3 deletions examples/00-fluent/mixing_elbow.py
Original file line number Diff line number Diff line change
Expand Up @@ -369,7 +369,6 @@
"banded",
"quit",
)
# session.solver.tui.display.objects.display("contour-vel")

###############################################################################
# Create and display a definition for temperature contours on the symmetry
Expand All @@ -393,7 +392,6 @@
"smooth",
"quit",
)
# session.solver.tui.display.objects.display("contour-temp")

###############################################################################
# Create and display velocity vectors on the symmetry-xyplane plane:
Expand All @@ -417,7 +415,6 @@
"2",
"quit",
)
# session.solver.tui.display.objects.display("vector")

###############################################################################
# Create an iso-surface representing the intersection of the plane z=0 and the
Expand Down
5 changes: 0 additions & 5 deletions examples/00-fluent/mixing_elbow_settings_api.py
Original file line number Diff line number Diff line change
Expand Up @@ -173,7 +173,6 @@
"velocity_vector_symmetry"
].scale.scale_f = 4
session.solver.root.results.graphics.vector["velocity_vector_symmetry"].style = "arrow"
# session.solver.root.results.graphics.vector["velocity_vector_symmetry"].display()

###############################################################################
# Compute mass flow rate
Expand All @@ -190,10 +189,6 @@
session.solver.root.solution.report_definitions.flux["mass_flow_rate"].print_state()
session.solver.root.solution.report_definitions.compute(report_defs=["mass_flow_rate"])

###############################################################################
# Write final case and data.
# session.solver.tui.file.write_case_data('mixing_elbow2_set.cas.h5')

#########################################################################
# Close Fluent

Expand Down
3 changes: 1 addition & 2 deletions setup.py
Original file line number Diff line number Diff line change
@@ -1,7 +1,6 @@
"""Setup file for ansys-fluent-core."""
import os
import shutil
import sys

from setuptools import find_namespace_packages, setup

Expand All @@ -28,7 +27,7 @@
"numpy>=1.21.5",
"protobuf==3.20.1",
"appdirs>=1.4.0",
"pandas>=1.4.1" if sys.version_info.minor > 7 else "pandas==1.3.5",
"pandas>=1.1.5",
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is the maximum supported version for python 3.7.0 (the minimum python version we support).

]


Expand Down
2 changes: 1 addition & 1 deletion src/ansys/fluent/core/launcher/launcher.py
Original file line number Diff line number Diff line change
Expand Up @@ -213,7 +213,7 @@ def launch_fluent(

additional_arguments : str, optional
Additional arguments in string format which will be sent to
Fluent launcher as is.
Fluent as is.

env : Dict[str, str], optional
Mapping to modify environment variables in Fluent
Expand Down