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
| Variable | Description |
|---|---|
EMODE_EULA_ACCEPTED=1 |
Accept the EULA non-interactively (CI/headless) |
EMODE_EMAIL |
Pre-fill login email |
EMODE_PASSWORD |
Pre-fill password (use with caution) |
EMODE_INTERACTIVE=1 |
Use interactive installer GUI |
UNINSTALL_EMODE=y |
Accept the uninstallation non-interactively |
Documentation
Full documentation is available at docs.emodephotonix.com.
License
See LICENSE for details.
MATLAB
A legacy MATLAB interface (emodeconnection.m) is included in this repository
for historical reference. It is no longer supported as of EMode 0.2.5 and may
not work with newer versions. No support is provided for MATLAB usage.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file emodeconnection-1.1.12.tar.gz.
File metadata
- Download URL: emodeconnection-1.1.12.tar.gz
- Upload date:
- Size: 58.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.7.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4f867dc66761d8aba55ce05c5ac35486b026e81e73cabae56d7a8d21c8e87cc8
|
|
| MD5 |
85829f145b73de71a066da77cfccecb1
|
|
| BLAKE2b-256 |
7d5e9ebe3c0c1796c53fdee956a913d9b2fde17888cdd1b4d7b454f5927d2163
|
File details
Details for the file emodeconnection-1.1.12-py3-none-any.whl.
File metadata
- Download URL: emodeconnection-1.1.12-py3-none-any.whl
- Upload date:
- Size: 29.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.7.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1eec85dec133f608a12220ba318b7456ceb7ba27e22883975eaef8a4d31486cb
|
|
| MD5 |
5a641cfe799ab3638f49ddf0800b75ae
|
|
| BLAKE2b-256 |
970ab274c8312f0833ed91044f06ec1899dcdcd77bb24a194c9f26430c4e15e7
|
