Installation#

This page describes how to install PyLumerical-MCP.

Check prerequisites#

Python 3.11 or later
A valid Lumerical installation and license

For information on setting up your license, see the following article in the Lumerical Knowledge Base: Lumerical license configuration using environment variable and ini files.

Create a virtual environment#

To install PyLumerical-MCP, create a virtual environment. While its creation is not strictly necessary, it is best practice to do so to avoid conflicts with other Python packages.

Create a virtual environment:

# Create a virtual environment
python -m venv .venv

Activate the virtual environment:

Linux

source .venv/bin/activate

Windows Command Prompt

.venv\\Scripts\\activate.bat

Windows PowerShell

.venv\\Scripts\\Activate.ps1

Install from PyPI#

To install from PyPI, first upgrade pip and then directly install PyLumerical-MCP:

python -m pip install -U pip
pip install ansys-lumerical-mcp

Install from GitHub#

Alternatively, clone the repository from GitHub and install it manually:

git clone https://github.com/ansys/pylumerical-mcp.git
cd pylumerical-mcp
python -m pip install -U pip
python -m pip install .

Verify the installation#

Ensure that the installation was successful by running this command from your environment:

ansys-lumerical-mcp