emodeconnection

Python interface for EMode, a photonics simulation platform for waveguide mode solving, propagation, and analysis.

Requirements

• Python 3.10 or higher
• An active EMode account and license
• EMode installed on your system (see Installation)

Installation

pip install emodeconnection

Quick Start

import emodeconnection as emc

# Open the EMode login window (only required on first use)
emc.EModeLogin()

## Connect and initialize EMode
em = emc.EMode(save = False)

## Draw shapes
em.shape(name = 'BOX', material = 'SiO2', height = 800)
em.shape(name = 'core', material = 'Si', width = 600, height = 400)

## Run FDM, display results, and close
em.FDM()
em.report()
em.close()

Features

• Simple Python API for EMode simulation sessions
• Automatic login and license management
• Cross-platform: Windows, macOS, Linux
• Command-line installer via emode-install

Installing EMode

The emodeconnection package includes a command-line tool to download and install the EMode executable:

emode-install

Options

emode-install                            # Install latest version
emode-install --help                     # Show all options
emode-install --list-versions            # Show available versions
emode-install --update                   # Update to the latest version
emode-install --update --version 0.2.5   # Switch to a specific version
emode-install --version 0.2.5            # Install a specific version
emode-install --install-dir /opt/bin     # Custom install directory
emode-install --uninstall                # Remove EMode
emode-install --uninstall --install-dir /opt/bin  # Remove from custom location

Environment variables

Wire protocol

emodeconnection talks to the EMode executable over a local socket. Each message is a 4-byte big-endian length followed by that many bytes of UTF-8 JSON. A NumPy array travels as {"__ndarray__": <base64>, "dtype", "shape"}, and a result object (such as SMatrix) carries its class name in __data_type__.

Every dictionary reply from EMode is stamped with the protocol version, "__version__": 1. A reply without the stamp is a plain value (a number, a string, a list, an array or None) and is returned unchanged. A reply stamped with any version other than 1 comes from a newer protocol than this client reads, and raises an EModeError asking you to upgrade emodeconnection.

Documentation

Full documentation is available at docs.emodephotonix.com.

License

See LICENSE for details.