Skip to main content

A python wrapper for Ansys Fluent parametric workflows

Project description

PyAnsys PyPI GH-CI MIT Black pre-commit.ci status

Overview

PyFluent-Parametric provides Pythonic access to Ansys Fluent’s parametric workflows.

Documentation and issues

For comprehensive information on PyFluent-Parametric, see the latest release documentation.

On the PyFluent-Parametric Issues, you can create issues to submit questions, report bugs, and request new features. To reach the project support team, email pyansys.core@ansys.com.

Installation

The ansys-fluent-parametric package currently supports Python 3.9 through Python 3.11 on Windows and Linux.

Install the latest release from PyPI with:

pip install ansys-fluent-parametric

Alternatively, install the latest from GitHub with:

pip install git+https://github.com/ansys/pyfluent-parametric.git

If you plan on doing local development of PyFluent with Git, install with:

git clone https://github.com/ansys/pyfluent-parametric.git
cd pyfluent-parametric
pip install pip -U
pip install -e .

Dependencies

You must have a locally-installed, licensed copy of Ansys to run Fluent. The first supported version is 2022 R2.

Getting started

Basic usage

The following code assumes that a PyFluent session has already been created and a Fluent case with input parameters has been set up. For a full example, see Defining Parametric Workflows in the PyFluent-Parametric documentation.

import ansys.fluent.core as pyfluent
from ansys.fluent.parametric import ParametricStudy
solver_session = pyfluent.launch_fluent(mode="solver")
study = ParametricStudy(solver_session.parametric_studies)
input_parameters_update = study.design_points["Base DP"].input_parameters
input_parameters_update["inlet1_vel"] = 0.5
study.design_points["Base DP"].input_parameters = input_parameters_update
study.update_current_design_point()
print(study.design_points["Base DP"].output_parameters)

License and acknowledgments

PyFluent-Parametric is licensed under the MIT license.

PyFluent-Parametric makes no commercial claim over Ansys whatsoever. This library extends the functionality of Fluent by adding a Python interface to Fluent without changing the core behavior or license of the original software. The use of the interactive Fluent control of PyFluent-Parametric requires a legally licensed local copy of Fluent.

For more information, see the Ansys Fluent <https://www.ansys.com/products/fluids/ansys-fluent> page on the Ansys website.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

ansys_fluent_parametric-0.10.0.tar.gz (14.5 kB view hashes)

Uploaded Source

Built Distribution

ansys_fluent_parametric-0.10.0-py3-none-any.whl (13.9 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page