Develop PyCFX-MCP#

Review naming conventions#

Surface

Name

GitHub repository

pycfx-mcp

PyPI distribution

ansys-cfx-mcp

Python package

ansys.cfx.mcp

Console script

ansys-cfx-mcp

Documentation title

PyCFX-MCP

Set up your development environment#

Create and activate a virtual environment, and then install the package in editable mode:

python -m venv .venv
source .venv/bin/activate
pip install -e ".[dev,doc]"

On Windows, activate the environment with .venv\Scripts\activate.

Run tests#

pytest -q

Run lint checks#

ruff check src tests

Build documentation#

From the doc directory, run:

make html

On Windows, run:

.\make.bat html