Fix for: Circuit Simulation: OPICS - "Unable to import the library: opics_ebeam" #303

[maxz411]

Link to same issue by another user: SiEPIC/SiEPIC_EBeam_PDK#303 (comment)
(the code change needed to be done here)

Hi Lukas,

When installing KLayout, SiEPIC-tools and SiEPIC_EBeam_PDK, there was a bug on both Windows 11 (AMD 5900X and Radeon 7900 XTX) and MacOS (M1 MBP). The error was as follows:

Whenever I:

• Load the example MZM layout
• Run an OPICS simulation

Exception: Unable to import the library: opics_ebeam
C:\Users\maxzh\KLayout\salt\siepic_tools\python\SiEPIC\opics\utils.py:312
C:\Users\maxzh\KLayout\salt\siepic_tools\python\SiEPIC\opics_netlist_sim.py:90
C:/Users/maxzh/KLayout/salt/siepic_tools/pymacros\Keybindings\Simulation\circuit_simulation OPICS.lym:7

Seems to me like the code is trying to import the package 'ebeam' specified in 'catalogue.yaml', but either never downloads it, or isn't using the 'ebeam' data provided by the PDK. The default directory where utils.py tries to find the package seems to be 'SiEPIC/opics/libraries', but that isn't the install location of the ebeam PDK when downloading using 'salt'. I tried simply copy and pasting the package to SiEPIC/opics/libraries, but that gave a new set of errors. I wrote some code to check and import from the correct directories. I agree it is not the most elegant solution, but I simply needed a working version to complete the passives workshop. Here it is!

Thank you,
Max.

[lukasc-ubc]

Thank you very much for working on a fix!

[codecov-commenter]

Codecov Report

Attention: Patch coverage is 0% with 50 lines in your changes missing coverage. Please review.

Project coverage is 23.32%. Comparing base (e0c43a4) to head (a9036db).

Files with missing lines	Patch %	Lines
klayout_dot_config/python/SiEPIC/opics/utils.py	0.00%	50 Missing ⚠️

Additional details and impacted files

@@            Coverage Diff             @@
##           master     #234      +/-   ##
==========================================
- Coverage   23.40%   23.32%   -0.09%     
==========================================
  Files          47       47              
  Lines       11464    11504      +40     
==========================================
  Hits         2683     2683              
- Misses       8781     8821      +40     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.