This step-by-step guide will show how to install CML Compiler on either a Windows or Linux system. There are three major steps to installing CML Compiler:
- Verify System Requirements and Installation Package
- Run Installer
- Test Installation & Get Started
Note: CML Compiler is part of the Lumerical products and can be downloaded at the Download page.
Step 1 - Verify System Requirements & Installation Package
Before installing CML Compiler, it should be verified that the system for which it is being installed has a supported operating system, as well as all the necessary licenses. Then, the installation package should be checked to ensure that it contains all the necessary files.
For Verilog-A CMLs, follow the guide in CML Compiler system requirements and installation for Verilog-A CMLs.
System Requirements for INTERCONNECT CMLs
CML Compiler supports installation with the following operating systems:
- RedHat® Enterprise Linux® (64-bit editions)
- Windows® (64-bit editions)
See our supported systems and platform page for details.
To properly run CML Compiler, the following licenses are required:
- Lumerical SYSTEM Circuit Simulation Suite
- INTERCONNECT Photonic Integrated Circuit Simulator
- CML Compiler
- Automation API
Step 2 - Run the Installer
Please follow the steps below for your operating system (Windows or Linux).
Step 2a - Installing on Windows
Unzip downloaded Lumerical package then navigate inside Lumerical_Suite and run Lumerical_Installer (may require administrator access).
Step 2b - Installing on Linux
Unzip downloaded Lumerical package and run install.sh (may require administrator access):
sudo ./install.sh
If you are using BASH, edit your user PATH by running:
nano ~/.bashrc
In the editor, append a new line:
export PATH=/opt/lumerical/[[verpath]]/bin/:$PATH
If you are using CSH, edit your user PATH by running:
nano ~/.cshrc
In the editor, append a new line:
setenv PATH $PATH\:/opt/lumerical/[[verpath]]/bin/\:
Note: You may either log out and log in or source .bashrc/.cshrc to update the environment.
With a clean installation, please continue to Getting Started with CML Compiler.
Step 3 - Advanced Windows Set-Up (Optional)
This section for Windows is optional and advanced. It is only applicable if you intend to launch CML Compiler from a custom terminal of your choice. The following steps can be omitted if you intend to launch and use CML Compiler from the Ansys Optics Launcher.
PATH on Windows
After installing CML Compiler, it needs to be added to the system PATH environment variable. To do so, open "Control Panel" and navigate to "Edit environment variables for your account". Select "PATH" in the System variables and click edit.
For Windows 7, add CML Compiler to the PATH by appending the following to the end:
;"C:\Program Files\Lumerical\[[verpath]]\bin"
The semicolon is used to separate different path entries in Windows 7, and the quotations are used as wrappers for the path. For Windows 10, add CML Compiler to the PATH by pressing "New" and copying the following text into the new line:
C:\Program Files\Lumerical\[[verpath]]\bin
[[NOTE:]] If you are using Git Bash as your terminal of choice, please use the following path instead:
C:\Program Files\Lumerical\[[verpath]]\CML_Compiler\bin