Merge branch 'SiEPIC:main' into main

.github/workflows/merge.yml

@@ -116,6 +116,7 @@ jobs:
       # merge script always runs on any PR, this ensures link is only updated after a PR is merged into SiEPIC
       - name: commit and push changes to README if we are in SiEPIC repo
         run: |
+          git pull origin main
           git diff
           git config --local user.email "${{ github.actor }}@users.noreply.github.com"
           git config --local user.name "${{ github.actor }}"

.github/workflows/python-to-oas_gds.yml

@@ -38,7 +38,7 @@ jobs:
 
           # get added/modified py files
           if [ "${{ github.event_name }}" == "push" ]; then
-            FILES=$(git diff --name-only --diff-filter=ACM ${{ github.event.before }} ${{ github.sha }} -- "submissions/KLayout Python" | grep -E '\.py$')
+            FILES=$(git diff --name-only --diff-filter=ACM ${{ github.event.before }} ${{ github.sha }} -- "submissions/KLayout Python" | grep -E '\.py$' | sed 's|^submissions/KLayout Python/||')
           else
             FILES=$(git diff --name-only --diff-filter=ACM FETCH_HEAD -- "submissions/KLayout Python" | grep -i -E '\.py$' | sed 's|^submissions/KLayout Python/||')
           fi
@@ -60,6 +60,8 @@ jobs:
 
             # run file and generate a gds / oas output
             python "submissions/KLayout Python/$file" 
+            # Lukas: for some reason, the "submissions/KLayout" part was showing up twice, and now it isn't.
+            # python "$file" 
 
             # get output and save to OUTPUT_FILES
             gds_files=$(find submissions -type f -name "*.gds" -exec basename {} .gds \;)
@@ -107,10 +109,12 @@ jobs:
           # git add all produced oas/gds files
           for file in $OUTPUT_FILES; do
             git add "submissions/$file"
-            echo "git add $file"
+            echo "done: git add $file"
           done
 
           git commit -m "Add oas and gds files produced from .py files" 
+          echo "done: git commit"
           git push
+          echo "done: git push"
         if: github.event_name != 'pull_request'
 

.github/workflows/run-verification.yml

@@ -17,8 +17,10 @@ on:
   pull_request:
     branches:
       - '**'
+
   # by default, GitHub only runs workflows on pull requests for approved users; this should allow it to run workshops on new users as well:
-  pull_request_target:
+  #pull_request_target:
+  # removed, since this action runs on the base code, and not the PR code, so won't actually test the PR
 
 
 jobs:
@@ -69,7 +71,7 @@ jobs:
           if [ "${{ github.event_name }}" == "workflow_run" ]; then
             FILES=$(ls ./binary_files)
           else
-            if [ "${{ github.event_name }}" = "pull_request" ]; then
+            if [[ "${{ github.event_name }}" == "pull_request" || "${{ github.event_name }}" == "pull_request_target" ]]; then
               # triggered on pull request, get all changed / added files from forked repo
               FILES=$(git diff --name-only --diff-filter=ACM FETCH_HEAD | grep -i -E '\.(gds|oas)$' | sed 's|^submissions/||')
             else
@@ -124,12 +126,14 @@ jobs:
 
             # if file results in verification errors add to string files_with_errors
             if [[ "$errors_from_output" -ge 1 ]]; then
+              echo "$output"
               files_with_errors+="$file, $errors_from_output errors. "
             fi
 
             echo "Done verification on $file"
           done
 
+          echo "$output" > verification_output.txt
           echo "files_with_errors=$files_with_errors" >> $GITHUB_ENV
 
       - name: move output lyrdb files to new folder
@@ -154,6 +158,7 @@ jobs:
           if [ -z "$files_with_errors" ]; then
             echo "No errors detected."
           else
+            cat verification_output.txt
             echo "Errors detected: $files_with_errors"
             exit 1
           fi

README.md

@@ -3,7 +3,6 @@
 
 - The Canadian Silicon Photonics Foundry, <a href="https://siepic.ca/fabrication/">SiEPICfab</a>, presents the open electron beam lithography (EBL) fabrication process, where former and current students of <a href="https://siepic.ca/education/">SiEPIC</a> workshops and courses can submit their design for manufacturing and testing.
 - More details about <a href="https://siepic.ca/openEBL/">openEBL</a>.
-- Slides: <a href="https://docs.google.com/presentation/d/18B8UAUWxal7vW1-bIIp5o7Mb6nLZ9Ep64zdLF2bcjPQ">link</a>
 
 # Fabrication process: Passive Silicon
 ## Technical summary:
@@ -33,7 +32,7 @@ The submission involves several steps. First, you need to create your design(s)
  - Design tools and process design kit (SiEPIC-EBeam-PDK, KLayout implementation)<a href="https://github.com/siepic/SiEPIC_EBeam_PDK/wiki/Installation-instructions"> installation instructions</a>. 
 
 ## Submission via GitHub
-
+ - [Watch this video for a demonstration](https://kaltura.clemson.edu/media/t/1_iwysnxub)
  - Create an account on GitHub
  - Fork a copy of this GitHub repository into your own account:  <a href="../../fork">Create a new fork</a>.
  - Turn on the GitHub Actions on your forked repository: <a href="../../actions">Actions</a> (In your repository's page on GitHub, click on Actions in the top-menu bar, and Enable the workflows).
@@ -42,6 +41,7 @@ The submission involves several steps. First, you need to create your design(s)
    - EBeam_username.oas: for the <a href="https://www.edx.org/learn/engineering/university-of-british-columbia-silicon-photonics-design-fabrication-and-data-ana">edX Phot1x silicon photonics design course</a>
    - ELEC413_username.oas: for the <a href="https://ece.ubc.ca/courses/elec-413/">UBC ELEC 413 course</a>
    - SiEPIC_Passives_username.oas: for the <a href="https://www.cmc.ca/passive-silicon-photonics-fabrication-workshop-2023">CMC SiEPIC Passives silicon photonics workshop</a>
+   - openEBL_username.gds: for past participants in the above courses
    - For example: EBeam_LukasChrostowski_rings.oas
  - Upload your design(s) into the "submissions" folder, as a binary file, namely a .gds (GDSII format) or .oas (OASIS format) file. 
     - This can be done via the GitHub web page, by navigating to the <a href=../../tree/main/submissions>submissions folder</a>, then clicking on Add file, and Upload files. 
@@ -50,17 +50,19 @@ The submission involves several steps. First, you need to create your design(s)
  - Alternatively upload your Python file, which will be compiled by a GitHub Action.  
    - For KLayout designs, use the "submissions/KLayout Python" folder, namely a .py (Python format) file.  e.g., EBeam_LukasChrostowski_MZI.py.  The Python file should save a gds or oas file into the parent "submissions" folder. The Python script needs to be executable in non-GUI mode, namely using "import klayout SiEPIC SiEPIC-EBeam-PDK"
  - Create a <a href="https://help.github.com/articles/using-pull-requests/">Pull Request</a> -- this will notify the team of your contribution, which we can aggregate into the main design file
- - Return to the main repository, and ensure that your design is correctly merged
+ - Return to the main repository, and ensure that your design is correctly merged. Download the Latest Merge file, below.
 
-## Automated GitHub Actions
+<img width="1281" alt="image" src="https://github.com/SiEPIC/openEBL-2024-02/assets/15843200/e4785a27-b971-4a64-8796-1e351f30c00e">
 
-1) Running the files in the "submissions/KLayout Python" folder, to generate the designs
+## Automated GitHub Actions
+Optional: The verification and merging is performed using GitHub actions. The repository implements the following:
+1) Running the Python files in the "submissions/KLayout Python" folder, to generate the designs
 2) Performing Manufacturing DRC verification on the designs in the "submissions" folder, and outputing the errors as an Artifact
 3) Performing Functional verification on the designs in the "submissions" folder, and outputing the errors as an Artifact
-4) Merging the designs from the "submissions" folder, and outputing merged layout as an Artifact
+4) Merging the designs from the "submissions" folder, and outputing merged layout as an Artifact in the main repository
 
 ## Latest Merge Layout File
 
 <!-- start-link -->
-https://github.com/SiEPIC/openEBL-2024-02/actions/runs/7717637992/artifacts/1206952257
+https://github.com/SiEPIC/openEBL-2024-02/actions/runs/7851812712/artifacts/1234961554
 <!-- end-link -->

merge/EBeam_merge.py

@@ -6,7 +6,7 @@
 
 Input:
 - folder submissions
-- containing files {EBeam*, ELEC463*, ELEC413*, SiEPIC_Passives*, SiEPIC_Actives*}.{GDS,gds,OAS,oas,py}
+- containing files {EBeam*, openEBL_*, ELEC463*, ELEC413*, SiEPIC_Passives*, SiEPIC_Actives*}.{GDS,gds,OAS,oas,py}
 Output
 - in folder "merge"
 -   files: EBeam.oas, EBeam.txt, EBeam.coords
@@ -123,6 +123,8 @@ def log(text):
 top_cell.insert(CellInstArray(cell_ELEC413.cell_index(), t))
 cell_SiEPIC_Passives = layout.create_cell("SiEPIC_Passives")
 top_cell.insert(CellInstArray(cell_SiEPIC_Passives.cell_index(), t))
+cell_openEBL = layout.create_cell("openEBL")
+top_cell.insert(CellInstArray(cell_openEBL.cell_index(), t))
 
 # Create a date	stamp cell
 cell_date = layout.create_cell('.merged:'+now.strftime("%Y-%m-%d-%H:%M:%S"))
@@ -134,17 +136,22 @@ def log(text):
 for f in [f for f in files_in if '.oas' in f.lower() or '.gds' in f.lower()]:
     filedate = datetime.fromtimestamp(os.path.getmtime(f)).strftime("%Y%m%d_%H%M")
     log("\nLoading: %s, dated %s" % (os.path.basename(f), filedate))
+    basefilename = os.path.basename(f)
 
     # Load layout  
     layout2 = pya.Layout()
     layout2.read(f)
 
-    if 'ebeam' in f.lower():
+    if 'ebeam' in basefilename.lower():
         course = 'edXphot1x'
-    elif 'elec413' in f.lower():
+    elif 'elec413' in basefilename.lower():
         course = 'ELEC413'
-    elif 'siepic_passives' in f.lower():
+    elif 'openebl' in basefilename.lower():
+        course = 'openEBL'
+    elif 'siepic_passives' in basefilename.lower():
         course = 'SiEPIC_Passives'
+    else:
+        course = 'openEBL'
 
     cell_course = eval('cell_' + course)
     log("  - course name: %s" % (course) )

run_verification.py

@@ -18,37 +18,49 @@
 # gds file to run verification on
 gds_file = sys.argv[1]
 
-# load into layout
-layout = pya.Layout()
-layout.read(gds_file)
-
-# get top cell from layout
-top_cell = layout.top_cell()
-
-# set layout technology because the technology seems to be empty, and we cannot load the technology using TECHNOLOGY = get_technology() because this isn't GUI mode
-# refer to line 103 in layout_check()
-# tech = layout.technology()
-# print("Tech:", tech.name)
-layout.TECHNOLOGY = get_technology_by_name('EBeam')
-
-# run verification
-zoom_out(top_cell)
-
-# get file path, filename, path for output lyrdb file
-path = os.path.dirname(os.path.realpath(__file__))
-filename = gds_file.split(".")[0]
-file_lyrdb = os.path.join(path,filename+'.lyrdb')
-
-# run verification
-num_errors = layout_check(cell = top_cell, verbose=True, GUI=True, file_rdb=file_lyrdb)
-
-# Make sure layout extent fits within the allocated area.
-cell_Width = 605000
-cell_Height = 410000
-bbox = top_cell.bbox()
-if bbox.width() > cell_Width or bbox.height() > cell_Height:
-   print('Error: Cell bounding box / extent is larger than the maximum size of 605 X 410 microns')
-   num_errors += 1
+try:
+   # load into layout
+   layout = pya.Layout()
+   layout.read(gds_file)
+except:
+   print('Error loading layout')
+   num_errors = 1
+
+try:
+   # get top cell from layout
+   if len(layout.top_cells()) != 1:
+      print('Error: layout does not have 1 top cell. It has %s.' % len(layout.top_cells()))
+      num_errors += 1
+
+   top_cell = layout.top_cell()
+
+   # set layout technology because the technology seems to be empty, and we cannot load the technology using TECHNOLOGY = get_technology() because this isn't GUI mode
+   # refer to line 103 in layout_check()
+   # tech = layout.technology()
+   # print("Tech:", tech.name)
+   layout.TECHNOLOGY = get_technology_by_name('EBeam')
+
+   # run verification
+   zoom_out(top_cell)
+
+   # get file path, filename, path for output lyrdb file
+   path = os.path.dirname(os.path.realpath(__file__))
+   filename = gds_file.split(".")[0]
+   file_lyrdb = os.path.join(path,filename+'.lyrdb')
+
+   # run verification
+   num_errors = layout_check(cell = top_cell, verbose=False, GUI=True, file_rdb=file_lyrdb)
+
+   # Make sure layout extent fits within the allocated area.
+   cell_Width = 605000
+   cell_Height = 410000
+   bbox = top_cell.bbox()
+   if bbox.width() > cell_Width or bbox.height() > cell_Height:
+      print('Error: Cell bounding box / extent (%s, %s) is larger than the maximum size of %s X %s microns' % (bbox.width()/1000, bbox.height()/1000, cell_Width/1000, cell_Height/1000) )
+      num_errors += 1
+except:
+   print('Unknown error occurred')
+   num_errors = 1
 
 # Print the result value to standard output
 print(num_errors)