Merge pull request #1 from SiEPIC/main

update my draft layout
SiEPIC · May 9, 2024 · 955f3b4 · 955f3b4
2 parents c23c826 + 7f420a5
commit 955f3b4
Show file tree

Hide file tree

Showing 37 changed files with 75 additions and 10 deletions.
diff --git a/.github/workflows/AutomaticApprove.yml b/.github/workflows/AutomaticApprove.yml
@@ -2,9 +2,13 @@ name: Automatic Approve
 on:
   schedule:
     - cron: "*/5 * * * *"
+
 jobs:
   automatic-approve:
     name: Automatic Approve
+    if: github.repository_owner == 'SiEPIC'
+       #if: >-
+       #github.event.pull_request.user.login != 'SiEPIC' && repository_dispatch.organization
     runs-on: ubuntu-latest
     steps:
       - name: Automatic Approve

diff --git a/.github/workflows/PullRequest.yml b/.github/workflows/PullRequest.yml
@@ -0,0 +1,48 @@
+name: PullRequest
+on:
+#  pull_request:
+#    branches:
+#      - '**'
+  pull_request_target:
+    branches:
+      - '**'
+
+
+jobs:
+  comment-in-pr:
+
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+      pull-requests: write
+      repository-projects: write
+      id-token: write
+
+    steps:
+      - name: Checkout, Generate message
+        uses: actions/checkout@v4
+      - run: |
+          SCRIPT_OUTPUT=$(cat << EOF
+          Thank you for uploading your design!
+
+          If you have not already checked it, please run the SiEPIC Functional Verification in KLayout, using the menu SiEPIC-Verification-Functional Layout Check (V).  
+          
+          Please note that we have added a new rule (on May 2, 2024) to SiEPIC-Tools and the EBeam PDK: The grating coupler spacing (pitch) must be at least 60.0 microns. This is to help avoid the probe station from accidentally aligning to an adjacent circuit. 
+          
+          You may continue making updates to your design, or even contributing additonal designs (using a separate file name), until the tape-out deadline.  
+          EOF
+          )
+          echo "SCRIPT_OUTPUT<<EOF" >> $GITHUB_ENV
+          echo "$SCRIPT_OUTPUT" >> $GITHUB_ENV
+          echo "EOF" >> $GITHUB_ENV
+
+      - uses: actions/github-script@v6
+        with:        
+          script: |
+            github.rest.issues.createComment({
+              issue_number: context.issue.number,
+              unique: true,
+              owner: context.repo.owner,
+              repo: context.repo.repo,
+              body: `${{env.SCRIPT_OUTPUT}}`
+            })
diff --git a/.github/workflows/python-to-oas_gds.yml b/.github/workflows/python-to-oas_gds.yml
@@ -65,7 +65,7 @@ jobs:
 
             # get output and save to OUTPUT_FILES
             gds_files=$(find submissions -type f -name "*.gds" -exec basename {} .gds \;)
-            oas_files=$(find submissions -type f -name "*.gds" -exec basename {} .oas \;)
+            oas_files=$(find submissions -type f -name "*.oas" -exec basename {} .oas \;)
 
             file_name=$(basename "$file")
             file_name_no_py=$(basename "$file_name" .py)

diff --git a/.github/workflows/run-verification.yml b/.github/workflows/run-verification.yml
@@ -138,7 +138,7 @@ jobs:
 
       - name: move output lyrdb files to new folder
         run: |
-          export OUTPUT_FILES=$(find /home/runner/work/openEBL-2024-02/openEBL-2024-02/submissions -name "*.lyrdb")
+          export OUTPUT_FILES=$(find /home/runner/work/openEBL-2024-05/openEBL-2024-05/submissions -name "*.lyrdb")
           echo "Output files: $OUTPUT_FILES"
 
           mkdir -p verification_output
@@ -162,4 +162,15 @@ jobs:
             echo "Errors detected: $files_with_errors"
             exit 1
           fi
-
+# this can only run in pull_request_target, not pull_request
+#      - name: Checkout
+#        uses: actions/checkout@v4
+#      - uses: actions/github-script@v6
+#        with:
+#          script: |
+#            github.rest.issues.createComment({
+#              issue_number: context.issue.number,
+#              owner: context.repo.owner,
+#              repo: context.repo.repo,
+#              body: 'It appears that your design has passed all the automated Functional Verification checks.  One of the fabrication run admin will merge your design soon.'
+#            })
diff --git a/README.md b/README.md
@@ -49,13 +49,13 @@ The submission involves several steps. First, you need to create your design(s)
  - 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. 
     - Click Commit changes, and wait for the verification (via GitHub actions) to complete. This will appear as a green checkmark or red X next to your commit on GitHub. 
-    - If there are errors, please review and correct the errors. You can run your verification locally (press V in KLayout) or download the output .lydrb verification file from GitHub.
+    - If there are errors, please review and correct the errors.
+    - Please run your verification locally (press V in KLayout), or download the output .lydrb verification file from GitHub and open in KLayout.
  -  "All checks have failed" <img width="864" alt="image" src="https://github.com/SiEPIC/openEBL-2024-05/assets/15843200/d5689514-eca0-423f-9288-b20ec4fdd5e9">
     - Click on Details
     - In the main, window expand the "Run layout verification"; see if there is a text description of the problem
     - Look for the Artifact file; download it and open it in KLayout
-  - After fixing the errors, you should have a green check mark as follows:
-   <img width="488" alt="image" src="https://github.com/SiEPIC/openEBL-2024-05/assets/15843200/4c502cc4-16c1-4115-8ad7-7d5fdfe715d3">
+  - After fixing the errors, you should have a green check mark as follows: <img width="488" alt="image" src="https://github.com/SiEPIC/openEBL-2024-05/assets/15843200/4c502cc4-16c1-4115-8ad7-7d5fdfe715d3">   
 - 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
@@ -77,5 +77,5 @@ Optional: The verification and merging is performed using GitHub actions. The re
 ## Latest Merge Layout File
 
 <!-- start-link -->
-https://github.com/SiEPIC/openEBL-2024-05/actions/runs/8989733583/artifacts/1481229975
+https://github.com/SiEPIC/openEBL-2024-05/actions/runs/9013977851/artifacts/1486940200
 <!-- end-link -->
diff --git a/submissions/EBeam_AnalemmaSuperNova.gds b/submissions/EBeam_AnalemmaSuperNova.gds
diff --git a/submissions/EBeam_LukasChrostowski_rings.oas b/submissions/EBeam_LukasChrostowski_rings.oas
diff --git a/submissions/EBeam_Matt_1925.gds b/submissions/EBeam_Matt_1925.gds
diff --git a/submissions/EBeam_Moshax94_V2.gds b/submissions/EBeam_Moshax94_V2.gds
diff --git a/submissions/EBeam_Nemo88.gds b/submissions/EBeam_Nemo88.gds
diff --git a/submissions/EBeam_PengL792_A.gds b/submissions/EBeam_PengL792_A.gds
diff --git a/submissions/EBeam_PengL792_B.gds b/submissions/EBeam_PengL792_B.gds
diff --git a/submissions/EBeam_Sanna99.gds b/submissions/EBeam_Sanna99.gds
diff --git a/submissions/EBeam_awsheldo.gds b/submissions/EBeam_awsheldo.gds
diff --git a/submissions/EBeam_cme7831.gds b/submissions/EBeam_cme7831.gds
diff --git a/submissions/EBeam_commlab_student.gds b/submissions/EBeam_commlab_student.gds
diff --git a/submissions/EBeam_dmascare.gds b/submissions/EBeam_dmascare.gds
diff --git a/submissions/EBeam_galihghiffari.gds b/submissions/EBeam_galihghiffari.gds
diff --git a/submissions/EBeam_gpano.gds b/submissions/EBeam_gpano.gds
diff --git a/submissions/EBeam_ilmy17.gds b/submissions/EBeam_ilmy17.gds
diff --git a/submissions/EBeam_mariusminnen_v4.gds b/submissions/EBeam_mariusminnen_v4.gds
diff --git a/submissions/EBeam_mattgrant345.gds b/submissions/EBeam_mattgrant345.gds
diff --git a/submissions/EBeam_muhamadabdullah.gds b/submissions/EBeam_muhamadabdullah.gds
diff --git a/submissions/EBeam_muhamadrizal.gds b/submissions/EBeam_muhamadrizal.gds
diff --git a/submissions/EBeam_nickwicklund.gds b/submissions/EBeam_nickwicklund.gds
diff --git a/submissions/EBeam_nwasserb.oas b/submissions/EBeam_nwasserb.oas
diff --git a/submissions/EBeam_qplox.gds b/submissions/EBeam_qplox.gds
diff --git a/submissions/EBeam_rclark0602.gds b/submissions/EBeam_rclark0602.gds
diff --git a/submissions/EBeam_stevenjones314.gds b/submissions/EBeam_stevenjones314.gds
diff --git a/submissions/EBeam_supertjhok.gds b/submissions/EBeam_supertjhok.gds
diff --git a/submissions/EBeam_teddyrebeirro.gds b/submissions/EBeam_teddyrebeirro.gds
diff --git a/submissions/EBeam_teddyrebeirro_old.gds b/submissions/EBeam_teddyrebeirro_old.gds
diff --git a/submissions/EBeam_tiagonfig.gds b/submissions/EBeam_tiagonfig.gds
diff --git a/submissions/Ebeam_Kennethnelsonn.gds b/submissions/Ebeam_Kennethnelsonn.gds
diff --git a/submissions/Ebeam_prakashdas_02.gds b/submissions/Ebeam_prakashdas_02.gds
diff --git a/submissions/KLayout Python/EBeam_LukasChrostowski_MZI.py b/submissions/KLayout Python/EBeam_LukasChrostowski_MZI.py
@@ -1,7 +1,9 @@
 '''
 --- Simple MZI ---
   
-by Lukas Chrostowski, 2020-2023
+by Lukas Chrostowski, 2020-2024
+
+
    
 Example simple script to
  - create a new layout with a top cell
@@ -21,7 +23,7 @@
 
 designer_name = 'LukasChrostowski'
 top_cell_name = 'EBeam_%s_MZI' % designer_name
-export_type = 'PCell'  # static: for fabrication, PCell: include PCells in file
+export_type = 'static'  # static: for fabrication, PCell: include PCells in file
 
 import pya
 from pya import *

diff --git a/submissions/KLayout Python/EBeam_LukasChrostowski_rings.py b/submissions/KLayout Python/EBeam_LukasChrostowski_rings.py
@@ -3,7 +3,7 @@
 in the SiEPIC-EBeam-PDK "EBeam" technology
 
 by Lukas Chrostowski, 2024
-
+ 
 Use instructions:
 
 Run in Python, e.g., VSCode