This section of "My first Verilog-A 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 user interface
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. In Linux, call
/opt/lumerical/<version>/bin/launcher3. Select CML Compiler and press ‘New Project’ to launch the CML Compiler.
4. A CML Compiler window will open.
Deploy Lumfoundry Template and run CML Compiler
1. To obtain the Lumfoundry Template repository, click on the ‘Deploy Lumfoundry’ and choose the directory to deploy the Lumfoundry Template repository. Keep “foundry name” as default in “deploy options” prompt. This will create a "lumfoundry_template" folder in your chosen directory.
2. Toggle the switch to ‘Verilog-A’.
3. Clicking on the Edit Library button, select your desired platform, and enable the ‘Symbol Generation’ option. For Synopsys platform only, you can edit the solver options to use either PrimeSim HSPICE or PrimeSim SPICE.
4. Select all the elements by checking the box beside the name column and click on ‘Build Tests + Prev Steps’.
| Note: For the required licenses to create Verilog-A library please refer to System requirements and installation for Verilog-A CMLs for OptoCompiler and System requirements and installation for Verilog-A CMLs for Cadence Virtuoso. |
This will validate the selected elements’ source data, compile the data to build the Verilog-A compact model libraries, and create quality assurance test benches for both libraries. It also automatically generates Virtuoso symbols and sets up the Component Description Format (CDF) for symbols. If compilation is successful, the status icon under “validate” and “Build” will turn green.
|
Note: VerilogA models is generated in the folder "lumfoundry_template/artifacts/veriloga/” Two separate folders, one for Verilog-A models, and one for Verilog-A primitives. Note: Symbol library is generated in the folder "lumfoundry_template/artifacts/<platform>_VerilogA Where <platform> is the selected Photonic Verilog-A platform. |
5. Load the library depending on the platform you have chosen. For Virtuoso, follow steps in Loading the Verilog- A Virtuoso library. For OptoCompiler, consult the in-product user manual. The library should be added to the Library Manager of your tool. 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.
6. You can see what data is required for this model by navigating to its folder in "lumfoundry_template/source/wg_strip_straight_c". Or 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.