This section of "My first INTERCONNECT CML" provides a step-by-step guide for how to deploy and explore Lumfoundry Template. In the subsequent sections, you will modify a copy of Lumfoundry Template to create a custom CML.
Here we assume you have completed:
After completing this section, please see:
Open CML Compiler graphical user interface (GUI)
1. Download and install Ansys Lumerical Suite, and obtain a CML Compiler license.
2. Open the Launcher. You can do this directly or by opening any Ansys Lumerical tool. On Windows, you can find the Launcher in your Start Menu. On Linux, you can call
/opt/lumerical/<version>/bin/launcher
3. Select CML Compiler and press "New Project" to launch the CML Compiler.
4. The CML compiler GUI will open, ready to run CML Compiler.
Deploy Lumfoundry Template and run CML Compiler
-
To obtain the Lumfoundry Template repository, click on the ‘Deploy Lumfoundry’ icon
in the GUI.
This will deploy a default ‘lumfoundry_template’ into the chosen folder as shown below.
CML Compiler needs a list of photonic elements and their information to run. This data is stored in a json format in the master file. The lumfoundry template comes with three different master files listing photonic elements from the template folder as shown below:
- "lumfoundry_template_basic.json" lists one basic template for each photonic model that we offer.
- "lumfoundry_template_statistical.json" lists all the statistical elements included in the lumfoundry template folder.
- "lumfoundry_template.json" lists all the templates included in the library from basic elements to advanced and statistical.
Any json file can be chosen as the library master file, when executing cml-compiler. For the purposes of this tutorial, "lumfoundry_template.json" is chosen.
2. In order to generate an INTERCONNECT compact model library for all elements in the master json file list, first click on ‘select all’ and then click on ‘Build Tests + Prev Steps’ button
as shown below.
This will validate the selected elements’ source data, compile the data to build INTERCONNECT compact model library, install the model library to INTERCONNECT envrionment, and build quality assurance test benches for the created compact models. If compilation is successful, the status icon under “validate” and “Build” will turn green.
Note: CML file is generated in the folder "lumfoundy_template/artifacts/interconnect/lumfoundry_template.cml" |
3. Open a new INTERCONNECT session using ‘Launch INTC’ button in the GUI. Find the "lumfoundry_template" design kit now installed. Browse the elements of this library to find elements like those in your library. In the next section of this tutorial, we will be looking to update the "lum_wg_strip_straight_c" element.
4. You can also see what data is required for this model by navigating to its folder in "lumfoundry_template/source/wg_strip_straight_c".
Alternatively, you can read about this element and its photonic model in the Waveguide Straight (Fixed) - Lumfoundry Template documentation. You can also browse the documentation for other elements Lumfoundry Templates.