PyFluent-Parametric
===================
|pyansys| |pypi| |GH-CI| |MIT| |black| |pre-commit|
.. |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-parametric.svg?logo=python&logoColor=white
:target: https://pypi.org/project/ansys-fluent-parametric
:alt: PyPI
.. |GH-CI| image:: https://github.com/ansys/pyfluent-parametric/actions/workflows/ci_cd.yml/badge.svg
:target: https://github.com/ansys/pyfluent-parametric/actions/workflows/ci_cd.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
.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/pyfluent-parametric/main.svg
:target: https://results.pre-commit.ci/latest/github/ansys/pyfluent-parametric/main
:alt: 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 <https://parametric.fluent.docs.pyansys.com>`_.
On the `PyFluent-Parametric Issues <https://github.com/ansys/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 <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
<https://pypi.org/project/ansys-fluent-parametric/>`_ with:
.. code:: console
pip install ansys-fluent-parametric
Alternatively, install the latest from `GitHub
<https://github.com/ansys/pyfluent-parametric>`_ with:
.. code:: console
pip install git+https://github.com/ansys/pyfluent-parametric.git
If you plan on doing local *development* of PyFluent with Git, install
with:
.. code:: console
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
<https://fluentparametric.docs.pyansys.com/users_guide/parametric_workflows.html>`_ in
the PyFluent-Parametric documentation.
.. code:: python
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.
Raw data
{
"_id": null,
"home_page": "https://github.com/ansys/pyfluent-parametric",
"name": "ansys-fluent-parametric",
"maintainer": "PyAnsys developers",
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": "pyansys.maintainers@ansys.com",
"keywords": null,
"author": "ANSYS, Inc.",
"author_email": "ansys.support@ansys.com",
"download_url": "https://files.pythonhosted.org/packages/bf/19/e42c11f76cc4dd36383356ad921144169851bda783c7766e554d3c0eefb2/ansys_fluent_parametric-0.10.0.tar.gz",
"platform": null,
"description": "PyFluent-Parametric\n===================\n|pyansys| |pypi| |GH-CI| |MIT| |black| |pre-commit|\n\n.. |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\n :target: https://docs.pyansys.com/\n :alt: PyAnsys\n\n.. |pypi| image:: https://img.shields.io/pypi/v/ansys-fluent-parametric.svg?logo=python&logoColor=white\n :target: https://pypi.org/project/ansys-fluent-parametric\n :alt: PyPI\n\n.. |GH-CI| image:: https://github.com/ansys/pyfluent-parametric/actions/workflows/ci_cd.yml/badge.svg\n :target: https://github.com/ansys/pyfluent-parametric/actions/workflows/ci_cd.yml\n :alt: GH-CI\n\n.. |MIT| image:: https://img.shields.io/badge/License-MIT-yellow.svg\n :target: https://opensource.org/licenses/MIT\n :alt: MIT\n\n.. |black| image:: https://img.shields.io/badge/code%20style-black-000000.svg?style=flat\n :target: https://github.com/psf/black\n :alt: Black\n\n.. |pre-commit| image:: https://results.pre-commit.ci/badge/github/ansys/pyfluent-parametric/main.svg\n :target: https://results.pre-commit.ci/latest/github/ansys/pyfluent-parametric/main\n :alt: pre-commit.ci status\n\nOverview\n--------\nPyFluent-Parametric provides Pythonic access to Ansys Fluent's parametric\nworkflows.\n\nDocumentation and issues\n------------------------\nFor comprehensive information on PyFluent-Parametric, see the latest\nrelease `documentation <https://parametric.fluent.docs.pyansys.com>`_.\n\nOn the `PyFluent-Parametric Issues <https://github.com/ansys/pyfluent-parametric/issues>`_,\nyou can create issues to submit questions, report bugs, and request new features. To reach\nthe project support team, email `pyansys.core@ansys.com <pyansys.core@ansys.com>`_.\n\nInstallation\n------------\nThe ``ansys-fluent-parametric`` package currently supports Python 3.9 through Python\n3.11 on Windows and Linux.\n\nInstall the latest release from `PyPI\n<https://pypi.org/project/ansys-fluent-parametric/>`_ with:\n\n.. code:: console\n\n pip install ansys-fluent-parametric\n\nAlternatively, install the latest from `GitHub\n<https://github.com/ansys/pyfluent-parametric>`_ with:\n\n.. code:: console\n\n pip install git+https://github.com/ansys/pyfluent-parametric.git\n\nIf you plan on doing local *development* of PyFluent with Git, install\nwith:\n\n.. code:: console\n\n git clone https://github.com/ansys/pyfluent-parametric.git\n cd pyfluent-parametric\n pip install pip -U\n pip install -e .\n\nDependencies\n------------\nYou must have a locally-installed, licensed copy of Ansys to run Fluent. The\nfirst supported version is 2022 R2.\n\nGetting started\n---------------\n\nBasic usage\n~~~~~~~~~~~\nThe following code assumes that a PyFluent session has already been created and a Fluent case\nwith input parameters has been set up. For a full example, see `Defining Parametric Workflows\n<https://fluentparametric.docs.pyansys.com/users_guide/parametric_workflows.html>`_ in\nthe PyFluent-Parametric documentation.\n\n.. code:: python\n\n import ansys.fluent.core as pyfluent\n from ansys.fluent.parametric import ParametricStudy\n solver_session = pyfluent.launch_fluent(mode=\"solver\")\n study = ParametricStudy(solver_session.parametric_studies)\n input_parameters_update = study.design_points[\"Base DP\"].input_parameters\n input_parameters_update[\"inlet1_vel\"] = 0.5\n study.design_points[\"Base DP\"].input_parameters = input_parameters_update\n study.update_current_design_point()\n print(study.design_points[\"Base DP\"].output_parameters)\n\nLicense and acknowledgments\n---------------------------\nPyFluent-Parametric is licensed under the MIT license.\n\nPyFluent-Parametric makes no commercial claim over Ansys whatsoever. This library\nextends the functionality of Fluent by adding a Python interface to Fluent without\nchanging the core behavior or license of the original software. The use of the\ninteractive Fluent control of PyFluent-Parametric requires a legally licensed\nlocal copy of Fluent.\n\nFor more information, see the `Ansys Fluent <https://www.ansys.com/products/fluids/ansys-fluent>`\npage on the Ansys website.\n\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "A python wrapper for Ansys Fluent parametric workflows",
"version": "0.10.0",
"project_urls": {
"Documentation": "https://parametric.fluent.docs.pyansys.com/",
"Homepage": "https://github.com/ansys/pyfluent-parametric",
"Repository": "https://github.com/ansys/pyfluent-parametric",
"Source": "https://github.com/ansys/pyfluent-parametric",
"Tracker": "https://github.com/ansys/pyfluent-parametric/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "117f4d72d6849dd5205128d3b9d38828fd16707dd3818a54b434b7fe51c1163c",
"md5": "9da6b9a046543de8a3eef223187270c3",
"sha256": "c90988799a760f85a42b2d37a6564af1bb2c30efdacf35b4556effc7f64d7f48"
},
"downloads": -1,
"filename": "ansys_fluent_parametric-0.10.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9da6b9a046543de8a3eef223187270c3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 13927,
"upload_time": "2024-04-01T16:34:17",
"upload_time_iso_8601": "2024-04-01T16:34:17.386618Z",
"url": "https://files.pythonhosted.org/packages/11/7f/4d72d6849dd5205128d3b9d38828fd16707dd3818a54b434b7fe51c1163c/ansys_fluent_parametric-0.10.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "bf19e42c11f76cc4dd36383356ad921144169851bda783c7766e554d3c0eefb2",
"md5": "2ebf8f4e35e27bbbebb4b63d28456361",
"sha256": "40402bc3aea1159d75117746f0593915a242f420c006fbaa9647e53bb6988bae"
},
"downloads": -1,
"filename": "ansys_fluent_parametric-0.10.0.tar.gz",
"has_sig": false,
"md5_digest": "2ebf8f4e35e27bbbebb4b63d28456361",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 14533,
"upload_time": "2024-04-01T16:34:19",
"upload_time_iso_8601": "2024-04-01T16:34:19.210804Z",
"url": "https://files.pythonhosted.org/packages/bf/19/e42c11f76cc4dd36383356ad921144169851bda783c7766e554d3c0eefb2/ansys_fluent_parametric-0.10.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-01 16:34:19",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "ansys",
"github_project": "pyfluent-parametric",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "ansys-fluent-parametric"
}
JSON
