PR to pull back changes of IIC branch

.github/ISSUE_TEMPLATE/bug_report.md

@@ -0,0 +1,32 @@
+---
+name: Bug report
+about: Create a report to help us improve
+title: ''
+labels: ''
+assignees: hpretl
+
+---
+
+**Describe the bug**
+A clear and concise description of what the bug is.
+
+**To Reproduce**
+Steps to reproduce the behavior:
+1. Go to '...'
+2. Click on '....'
+3. Scroll down to '....'
+4. See error
+
+**Expected behavior**
+A clear and concise description of what you expected to happen.
+
+**Screenshots**
+If applicable, add screenshots to help explain your problem.
+
+**Environment:**
+ - OS: [e.g. Windows, macOS, Linux]
+ - Operating mode: [e.g. VNC, X11]
+ - Version tag [e.g. 2022.12]
+
+**Additional context**
+Add any other context about the problem here.

.github/ISSUE_TEMPLATE/feature_request.md

@@ -0,0 +1,20 @@
+---
+name: Feature request
+about: Suggest an idea for this project
+title: ''
+labels: ''
+assignees: hpretl
+
+---
+
+**Is your feature request related to a problem? Please describe.**
+A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
+
+**Describe the solution you'd like**
+A clear and concise description of what you want to happen.
+
+**Describe alternatives you've considered**
+A clear and concise description of any alternative solutions or features you've considered.
+
+**Additional context**
+Add any other context or screenshots about the feature request here.

.github/workflows/devcontainer-docker.yaml

@@ -0,0 +1,59 @@
+name: "Build and publish devcontainer"
+on:
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Container version'
+        required: true
+        default: 'latest'
+
+env:
+  REGISTRY: ghcr.io
+  # This does not work as the lowercase conversion does not work then,
+  # and we don't want the name of the docker container to clash
+  #IMAGE_NAME: ${{ github.repository }}
+  IMAGE_NAME: ${{ github.repository_owner }}/iic-osic-tools-devcontainer
+
+jobs:
+  build-and-push-image:
+    runs-on: ubuntu-latest
+
+    permissions:
+      contents: read
+      packages: write
+      attestations: write
+      id-token: write
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Log in to the Container registry
+        uses: docker/login-action@65b78e6e13532edd9afa3aa52ac7964289d1a9c1
+        with:
+          registry: ${{ env.REGISTRY }}
+          username: ${{ github.actor }}
+          password: ${{ secrets.GITHUB_TOKEN }}    
+
+      - name: Extract metadata (tags, labels) for Docker
+        id: meta
+        uses: docker/metadata-action@9ec57ed1fcdbf14dcef7dfbe97b2010124a938b7
+        with:
+          images: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}
+
+      - name: Build and push Docker image
+        id: push
+        uses: docker/build-push-action@f2a1d5e99d037542a71f64918e516c093c6f3fc4
+        with:
+          context: "./_build/devcontainer/image/"
+          push: true
+          tags: "${{ env.REGISTRY }}/${{ env.IMAGE_NAME }}:${{ github.event.inputs.version }}"
+          labels: ${{ steps.meta.outputs.labels }}
+          build-args: VERSION=${{ github.event.inputs.version }}
+
+      - name: Generate artifact attestation
+        uses: actions/attest-build-provenance@v1
+        with:
+          subject-name: ${{ env.REGISTRY }}/${{ env.IMAGE_NAME}}
+          subject-digest: ${{ steps.push.outputs.digest }}
+          push-to-registry: true

.github/workflows/devcontainer-template.yaml

@@ -0,0 +1,24 @@
+name: "Release devcontainer template"
+on:
+  workflow_dispatch:
+
+jobs:
+  deploy-templates:
+    if: ${{ github.ref == 'refs/heads/main' }}
+    runs-on: ubuntu-latest
+    permissions:
+      packages: write
+      contents: write
+      pull-requests: write
+    steps:
+      - uses: actions/checkout@v3
+
+      - name: "Publish Templates"
+        uses: devcontainers/action@v1
+        with:
+          publish-templates: "true"
+          base-path-to-templates: "./_build/devcontainer/iic-osic-tools"
+          generate-docs: "true"
+
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}

.gitignore

@@ -1,2 +1,21 @@
-**/*.pyc
-**/.DS_Store
+# ========================================================================
+# Editor swap/backup files
+# ========================================================================
+*~
+*swp
+
+# ========================================================================
+# Python compiled files
+# ========================================================================
+*.pyc
+
+# ========================================================================
+# macOS files
+# ========================================================================
+.DS_Store
+
+# ========================================================================
+# Misc configuration files
+# ========================================================================
+eda_user_credentials*.json
+/_tests/runs

.vscode/ltex.dictionary.en-US.txt

@@ -0,0 +1,50 @@
+BiCMOS
+cace
+cocotb
+cvc
+devcontainer
+Devcontainers
+DockerHub
+edalize
+fusesoc
+gdsfactory
+gdspy
+ghdl
+ghdl-yosys-plugin
+GlobalFoundries
+gtkwave
+IIC-OSIC-TOOLS
+irsim
+iverilog
+JKU
+klayout
+klayout-pex
+Kwantae
+lctime
+libman
+MOSFET
+netgen
+netlist
+ngspice
+ngspyce
+noVNC
+nvc
+OSDI
+PDKs
+PEX
+SiGe
+SkyWater
+VcXsrc
+VcXsrv
+VirtioFS
+XLaunch
+XQuartz
+ORFS
+WSLg
+OpenROAD
+OpenEMS
+PyOPUS
+LIBGL
+IIC-OSIC-Tools
+Podman
+Murmann

.vscode/settings.json

@@ -0,0 +1,39 @@
+{
+    "cSpell.words": [
+        "ASIC",
+        "cocotb",
+        "designinit",
+        "Devcontainers",
+        "edalize",
+        "efabless",
+        "FOSS",
+        "fusesoc",
+        "gdsfactory",
+        "gdspy",
+        "ghdl",
+        "gtkwave",
+        "irsim",
+        "iverilog",
+        "KLAYOUT",
+        "Kwantae",
+        "lctime",
+        "libman",
+        "netgen",
+        "ngspyce",
+        "openlane",
+        "openram",
+        "openroad",
+        "opensta",
+        "openvaf",
+        "ORFS",
+        "OSIC",
+        "PDKPATH",
+        "pdks",
+        "stdcell",
+        "USERINIT",
+        "Verilog",
+        "VHDL",
+        "Xvnc",
+        "yosys"
+    ]
+}

CITATION.cff

@@ -0,0 +1,15 @@
+cff-version: 1.2.0
+message: "If you use this Docker container or base your work on it, please cite it as below."
+authors:
+- family-names: Pretl
+  given-names: Harald
+  orcid: https://orcid.org/0000-0003-1519-076X
+- family-names: Zachl
+  given-names: Georg
+  orcid: https://orcid.org/0009-0006-7676-6389
+title: "GitHub repository of the IIC-OSIC-TOOLS"
+date-released: 2023-09-18
+url: https://github.com/iic-jku/IIC-OSIC-TOOLS
+identifiers:
+  - type: doi
+    value: 10.5281/zenodo.14387234

KNOWN_ISSUES.md

@@ -0,0 +1,109 @@
+# IIC-OSIC-TOOLS Known Issues
+
+## Container
+
+### Using the X11-mode on Linux with Docker Desktop
+
+Due to the quite different way of how Docker Desktop works to the classical Docker CE, `socat` is required to forward the X11 sockets to the container.
+To install socat, here are the commands for popular distributions:
+- Ubuntu/Debian (deb-based): `sudo apt-get -y install socat`
+- Arch/Manjaro (pacman-based): `pacman -S socat`
+- Fedora/RHEL/Rocky/Alma (rpm-based, RHEL-clones): `dnf -y install socat`
+- SuSE/openSUSE (rpm-based, SuSE-clones): `zypper install socat`
+
+### Switching to WSLg for graphical applications on Windows
+
+The current variant of the `start_x.bat` for Windows uses WSLg for audio & visual output, which comes preinstalled/packaged with WSL (Windows 10 Build 19044 or Windows 11). If problems arise, update WSL according to [the Microsoft website](https://learn.microsoft.com/en-us/windows/wsl/tutorials/gui-apps).
+
+### Frequent crashes of `xschem` on Windows 10+
+
+Since the update of the image to Ubuntu 24.04 LTS with tag `2025.01` there are reports of frequent crashes of `xschem` under Windows 11 using certain versions of specific X-servers. It has been found that using <https://vcxsrv.com> version `64.1.17.2.0` under Windows 11 works well (see [issue 92](https://github.com/iic-jku/IIC-OSIC-TOOLS/issues/92)).
+
+### Issues with OpenGL on some environments
+
+A few applications are using OpenGL graphics, which can lead to issues on some computing environments. A (potential) remedy is to enable SW-rendering with can be achieved by setting the following environment variable inside the Docker VM:
+
+```bash
+export LIBGL_ALWAYS_INDIRECT=0
+```
+
+### Issues with KLayout PCell libraries
+
+Some PCell libraries were developed for `gdsfactory7`, such as 
+   - Skywater `sky130A`
+   - Global Foundries `gf180mcuD`
+
+The image installs `gdsfactory9` by default, which is incompatible with `gdsfactory7` code (issue https://github.com/iic-jku/IIC-OSIC-TOOLS/issues/162#issuecomment-3219211141)
+
+#### Workaround for GF180
+
+The workaround, as described by the PCell authors [in this README](https://github.com/mabrains/gf180mcu_setup_pdk/blob/main/README.md),
+is to start KLayout from a custom Python VENV:
+```bash
+# create the venv (done once)
+mkdir -p /foss/designs/venvs/
+python3 -m venv /foss/designs/venvs/klayout_gf180
+pip3 install gdsfactory==7.9.4
+
+# this must be done everytime
+source /foss/designs/venvs/klayout_gf180/bin/activate
+export USER=designer
+export KLAYOUT_PYTHONPATH=/foss/designs/venvs/klayout_gf180/lib/python3.12/site-packages
+sak-pdk gf180mcuD
+klayout -e
+```
+
+### The OpenROAD Flow Scripts (ORFS)
+
+The ORFS require a recent version of `openroad`. Since image tag `2024.12` a recent version is installed alongside the OpenROAD version required by `librelane`. In order to use the ORFS, **before** calling the `make` script make sure to set the following env vars:
+
+```bash
+export YOSYS_EXE=$TOOLS/yosys/bin/yosys
+export OPENROAD_EXE=$TOOLS/openroad-latest/bin/openroad
+export OPENSTA_EXE=$TOOLS/openroad-latest/bin/sta
+```
+
+Since the OpenROAD and ORFS version are tightly interlinked with regular interface breaks, the ORFS Git commit hash at image build time is stored in `$TOOLS/openroad-latest/ORFS_COMMIT`. After cloning ORFS from GitHub use the following command to switch to a working and tested ORFS version:
+
+```bash
+git checkout $(cat $TOOLS/openroad-latest/ORFS_COMMIT)
+```
+### SiliconCompiler
+
+SiliconCompiler also requires a recent version of OpenROAD and OpenSTA. Before invoking SiliconCompiler, you
+need to update your `$PATH`:
+
+```bash
+export PATH=${TOOLS}/openroad-latest/bin:${PATH}
+```
+
+See: <https://github.com/iic-jku/IIC-OSIC-TOOLS/issues/158>
+
+### Surfer crashing
+
+As of image `2025.01` Surfer has been added. Surfer is known to crash on quite a few platforms due to issues with OpenGL drivers. If Surfer works on your platform, great. If Surfer does crash then this is not good, but there is currently no solution available. Please do not file bug reports. As soon as we are aware of a solution for these crashes we will implement the fixes.
+
+### OpenEMS
+
+The visualization tool "AppCSXCAD" will not work in the container with our default settings (`vtkXOpenGLRenderWindow (0x....): Cannot create GLX context.  Aborting.`). The issue has been located to be connected with the environment variable "LIBGL_ALWAYS_INDIRECT". As a workaround, we suggest either unsetting the variable or setting it to 0 (`unset LIBGL_ALWAYS_INDIRECT` or `export LIBGL_ALWAYS_INDIRECT=0`) which is persistent for the running terminal or run AppCSXCAD with the variable set to zero inline: `LIBGL_ALWAYS_INDIRECT=0 AppCSXCAD`.
+
+### PyOPUS
+
+`PyOPUS` is removed, as build fails, and it forces `numpy` to version 1.
+
+### Podman compatibility
+
+The IIC-OSIC-Tools container can be run using Podman instead of Docker (with the Podman Docker compatible CLI), but it introduces some problems:
+
+- By default, Podman mounts all bind-mounts/volumes as root, even though the `UID` inside the container is != 0, which creates some problems when accessing files inside the container. To work around this issue, we suggest the following procedure:
+- Edit the desired start script and find/replace all occurrences of `:rw` with `:U,rw`. Then Podman will mount all listed directories with the given `UID` inside the container.
+
+### CharLib
+
+The `charlib` tools works but needs the following setting: `simulator: ngspice-subprocess` in the `settings` block.
+
+See <https://github.com/iic-jku/IIC-OSIC-TOOLS/issues/145#issuecomment-3410979281>
+
+## Build
+
+No known issues at the moment.

LICENSE

@@ -186,7 +186,8 @@
       same "printed page" as the copyright notice for easier
       identification within third-party archives.
 
-   Copyright [yyyy] [name of copyright owner]
+   Copyright 2021-2025 Department for Integrated Circuits, 
+   Johannes Kepler University, Linz, Austria
 
    Licensed under the Apache License, Version 2.0 (the "License");
    you may not use this file except in compliance with the License.