Installation#

Check prerequisites#

  • Python 3.12 or later

  • A licensed local Ansys CFX installation for live CFX-Pre, CFX-Solver, or CFD-Post workflows

  • PyCFX through ansys-cfx-core for live-session tools

Install PyCFX-MCP from PyPI#

Use pip for the simplest installation:

pip install ansys-cfx-mcp

To enable native multi-provider LLM transport for optional codegen fallback calls, install the providers extra:

pip install "ansys-cfx-mcp[providers]"

Install PyCFX-MCP from source#

Install from the source repository:

git clone https://github.com/ansys/pycfx-mcp.git
cd pycfx-mcp
pip install -e .

Install development dependencies#

If you plan to contribute, install development dependencies:

pip install -e ".[dev]"

If you plan to build documentation, install documentation dependencies:

pip install -e ".[doc]"

If you need both sets of dependencies in one environment, install both extras:

pip install -e ".[dev,doc]"

Verify installation#

To verify your installation, run this command from the command-line tool to display help:

ansys-cfx-mcp --help

Next steps#

  • To launch your first CFX workflow, see Quick start.

  • For detailed usage instructions, see the User guide.