eda-setup.sh

#!/bin/bash
# ========================================================================
# Initialization of IIC Open-Source EDA Environment for OpenRule1umPDK
#
# SPDX-FileCopyrightText: 2023-2025 Mori Mizuki, Noritsuna Imamura 
# ISHI-KAI
# 
# SPDX-FileCopyrightText: 2021-2022 Harald Pretl, Johannes Kepler 
# University, Institute for Integrated Circuits
#
# Licensed under the Apache License, Version 2.0 (the "License");
# you may not use this file except in compliance with the License.
# You may obtain a copy of the License at
#
#     http://www.apache.org/licenses/LICENSE-2.0
#
# Unless required by applicable law or agreed to in writing, software
# distributed under the License is distributed on an "AS IS" BASIS,
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
# See the License for the specific language governing permissions and
# limitations under the License.
# SPDX-License-Identifier: Apache-2.0
#
# This script installs xschem, ngspice, magic, netgen, klayout
# and a few other tools for use with OpenRule1umPDK.
# This script supports WSL(Windows Subsystem for Linux), Ubuntu 22.04, macOS.
# ========================================================================

# Define setup environment
# ------------------------
export SRC_DIR="$HOME/src"
my_path=$(realpath "$0")
my_dir=$(dirname "$my_path")
export SCRIPT_DIR="$my_dir"
export KLAYOUT_VERSION=0.30.7

export TCL_VERSION=8.6.14
export TK_VERSION=8.6.14
export GTK_VERSION=3.24.42

# for Mac
if [ "$(uname)" == 'Darwin' ]; then
  VER=`sw_vers -productVersion | awk -F. '{ print $1 }'`
  case $VER in
    "14")
      export MAC_OS_NAME=Sonoma
      export CC_VERSION=-14
      export CXX_VERSION=-14
      ;;
    "15")
      export MAC_OS_NAME=Sequoia
      export CC_VERSION=-14
      export CXX_VERSION=-14
      ;;
    "26")
      export MAC_OS_NAME=Tahoe
      export CC_VERSION=-15
      export CXX_VERSION=-15
      ;;
    *)
      echo "Your Mac OS Version ($VER) is not supported."
      exit 1
      ;;
  esac
  export MAC_ARCH_NAME=`uname -m`
fi

# for Ubuntu
if [ "$(expr substr $(uname -s) 1 5)" == 'Linux' ]; then
  OS='Linux'
  export UBUNTU_VERSION_ID=`lsb_release -r | awk -F: '{ print $2 }'`
fi


# ---------------
# Now go to work!
# ---------------

# Update installation
# ----------------------------------
# the sed is needed for xschem build
echo ">>>> Update packages"
if [ "$(uname)" == 'Darwin' ]; then
  OS='Mac'
  if [ ! -d "/opt/homebrew" ]; then
    /bin/bash -c "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/HEAD/install.sh)"
    (echo; echo 'eval "$(/opt/homebrew/bin/brew shellenv)"') >> $HOME/.zprofile
    eval "$(/opt/homebrew/bin/brew shellenv)"
    brew update
    brew upgrade
    brew install wget
  fi
  brew update
  brew upgrade
elif [ "$(expr substr $(uname -s) 1 5)" == 'Linux' ]; then
  OS='Linux'
  . /etc/os-release
  if [ "$(expr substr $UBUNTU_VERSION_ID 1 5)" == '22.04' ]; then
    echo "Your platform is Ubuntu $UBUNTU_VERSION_ID."
  elif [ "$(expr substr $UBUNTU_VERSION_ID 1 5)" == '24.04' ]; then
    echo "Your platform is Ubuntu $UBUNTU_VERSION_ID."
  else
    echo "Your platform Ubuntu $UBUNTU_VERSION_ID is not supported."
    exit 1
  fi
  sudo sed -i 's/# deb-src/deb-src/g' /etc/apt/sources.list
  sudo apt -qq update -y
  sudo apt -qq upgrade -y
elif [ "$(expr substr $(uname -s) 1 10)" == 'MINGW32_NT' ]; then
  OS='Cygwin'
  echo "Your platform ($(uname -a)) is not supported."
  exit 1
else
  echo "Your platform ($(uname -a)) is not supported."
  exit 1
fi
mkdir $SRC_DIR
cd $SRC_DIR


# Copy KLayout Configurations
# ----------------------------------
if [ ! -d "$HOME/.klayout" ]; then
  mkdir -p $HOME/.klayout/salt
  mkdir $HOME/.klayout/macros
  mkdir $HOME/.klayout/drc
  mkdir $HOME/.klayout/pymacros
  mkdir $HOME/.klayout/libraries
fi


# Install basic tools via apt
# ------------------------------------------
echo ">>>> Installing required packages via APT"
if [ "$(uname)" == 'Darwin' ]; then
  OS='Mac'
  python3 -m pip install --upgrade pip
elif [ "$(expr substr $(uname -s) 1 5)" == 'Linux' ]; then
  OS='Linux'
  sudo apt -qq install -y build-essential python3-pip
elif [ "$(expr substr $(uname -s) 1 10)" == 'MINGW32_NT' ]; then
  OS='Cygwin'
  echo "Your platform ($(uname -a)) is not supported."
  exit 1
else
  echo "Your platform ($(uname -a)) is not supported."
  exit 1
fi



# Install/update xschem
# ---------------------
if [ ! -d "$SRC_DIR/xschem" ]; then
  echo ">>>> Installing xschem"
  if [ "$(uname)" == 'Darwin' ]; then
    OS='Mac'
    brew install libx11
    brew install libxpm
    brew install gawk
    brew install macvim
    brew install dbus
    brew install wget
    brew install --cask xquartz
    brew install libglu freeglut

    cd $SRC_DIR
    wget https://prdownloads.sourceforge.net/tcl/tcl$TCL_VERSION-src.tar.gz
    tar xfz tcl$TCL_VERSION-src.tar.gz
    rm tcl$TCL_VERSION-src.tar.gz
    cd tcl$TCL_VERSION/unix
    ./configure
    make -j$(nproc)
    sudo make install
    make clean

    cd $SRC_DIR
    wget https://prdownloads.sourceforge.net/tcl/tk$TK_VERSION-src.tar.gz
    tar xfz tk$TK_VERSION-src.tar.gz
    rm tk$TK_VERSION-src.tar.gz
    cd tk$TK_VERSION/unix
    ./configure
    #sed -i '' "s/-sectcreate __TEXT __info_plist Tk-Info.plist/-Wl,-sectcreate,__TEXT,__info_plist,Tk-Info.plist/g" Makefile
    sed -i '' $'280i\\\nTK_SHLIB_LD_EXTRAS = -sectcreate __TEXT __info_plist Tk-Info.plist\n' Makefile
    make -j$(nproc)
    sudo make install
    make clean
    
    echo 'export DYLD_LIBRARY_PATH="/usr/local/lib:$DYLD_LIBRARY_PATH"' >> ~/.zshrc
    
  elif [ "$(expr substr $(uname -s) 1 5)" == 'Linux' ]; then
    OS='Linux'
    sudo apt -qq install -y xterm graphicsmagick ghostscript \
    libx11-6 libx11-dev libxrender1 libxrender-dev \
    libxcb1 libx11-xcb-dev libcairo2 libcairo2-dev  \
    tcl8.6 tcl8.6-dev tk8.6 tk8.6-dev \
    flex bison libxpm4 libxpm-dev gawk tcl-tclreadline
  elif [ "$(expr substr $(uname -s) 1 10)" == 'MINGW32_NT' ]; then
    OS='Cygwin'
    echo "Your platform ($(uname -a)) is not supported."
    exit 1
  else
    echo "Your platform ($(uname -a)) is not supported."
    exit 1
  fi
  git clone https://github.com/StefanSchippers/xschem.git "$SRC_DIR/xschem"
  cd "$SRC_DIR/xschem" || exit
  ./configure CFLAGS="-Wno-error=implicit-function-declaration"
  if [ "$(uname)" == 'Darwin' ]; then
    sed -i '' "s/-ltcl8.5 -ltk8.5/-ltcl8.6 -ltk8.6/g" Makefile.conf
  fi  
else
  echo ">>>> Updating xschem"
  cd "$SRC_DIR/xschem" || exit
  git pull
fi
make clean
make -j"$(nproc)" && sudo make install
make clean



# Install/update xschem-gaw
# -------------------------
if [ ! -d "$SRC_DIR/xschem-gaw" ]; then
  echo ">>>> Installing gaw"
  if [ "$(uname)" == 'Darwin' ]; then
    OS='Mac'
    brew install pkg-config
    brew install automake
    brew install autoconf
    brew install gtk+3
    brew install m4
    export PATH="$(brew --prefix m4)/bin:$PATH"

    cd $SRC_DIR
    wget https://download.gnome.org/sources/gtk+/3.24/gtk+-$GTK_VERSION.tar.xz
    tar xfj gtk+-$GTK_VERSION.tar.xz
    rm gtk+-$GTK_VERSION.tar.xz
    cd gtk+-$GTK_VERSION/
    cd gdk
    sudo mkdir /usr/local/include/gdk/
    sudo cp *.h /usr/local/include/gdk/
    cd x11
    sudo mkdir /usr/local/include/gdk/x11/
    sudo cp *.h /usr/local/include/gdk/x11/

  elif [ "$(expr substr $(uname -s) 1 5)" == 'Linux' ]; then
    OS='Linux'
    sudo apt -qq install -y libgtk-3-dev alsa libasound2-dev gettext libtool
  elif [ "$(expr substr $(uname -s) 1 10)" == 'MINGW32_NT' ]; then
    OS='Cygwin'
    echo "Your platform ($(uname -a)) is not supported."
    exit 1
  else
    echo "Your platform ($(uname -a)) is not supported."
    exit 1
  fi
  git clone https://github.com/StefanSchippers/xschem-gaw.git "$SRC_DIR/xschem-gaw"
  cd "$SRC_DIR/xschem-gaw" || exit
  export GETTEXT_VERSION=0.20
#  export GETTEXT_VERSION=`gettext --version | awk 'NR==1{print $4}'`
  if [ "$(uname)" == 'Darwin' ]; then
    OS='Mac'
    export GETTEXT_VERSION=0.22
    gettextize -f
    aclocal -I m4 && automake --add-missing && autoconf
    sed -i '' "s/GETTEXT_MACRO_VERSION = 0.18/GETTEXT_MACRO_VERSION = $GETTEXT_VERSION/g" po/Makefile.in.in
    sed -i '' "s/linux/netinet/g" lib/sockcon.c
    ./configure --enable-gawsound=no LDFLAGS="-L/usr/X11/lib"
  elif [ "$(expr substr $(uname -s) 1 5)" == 'Linux' ]; then
    OS='Linux'
    aclocal && automake --add-missing && autoconf
    sed -i "s/GETTEXT_MACRO_VERSION = 0.18/GETTEXT_MACRO_VERSION = $GETTEXT_VERSION/g" po/Makefile.in.in
    ./configure
  fi
else
  echo ">>>> Updating gaw"
  cd "$SRC_DIR/xschem-gaw" || exit
  git pull
  if [ "$(uname)" == 'Darwin' ]; then
    OS='Mac'
    export PATH="$(brew --prefix m4)/bin:$PATH"
  fi
fi
make clean
make -j"$(nproc)" && sudo make install
make clean

# Install/Update KLayout
# ---------------------
echo ">>>> Installing KLayout-$KLAYOUT_VERSION"
if [ "$(uname)" == 'Darwin' ]; then
  OS='Mac'
  python3 -m pip install docopt pandas scipy matplotlib pip-autoremove --break-system-packages
  if [ ! -d "$SRC_DIR/klayout" ]; then
    echo ">>>> Building klayout"
    if [ "$(MAC_ARCH_NAME)" == 'arm64' ]; then
      brew install qt pyqt qt-builder
    else
      brew install qt pyqt pyqt-builder
    fi
    brew link qt --force
    brew install libgit2
    brew install ruby@3.4
    git clone --depth 1 https://github.com/KLayout/klayout.git "$SRC_DIR/klayout"
    cd "$SRC_DIR/klayout" || exit
    echo 'export PATH="$HOME/bin/:/usr/local/bin/:$PATH"' >> ~/.zshrc
  else
    echo ">>>> Updating klayout"
    cd "$SRC_DIR/klayout" || exit
    git pull
  fi
  python3 build4mac.py -r HB34 -p HBAuto -q Qt6Brew -m ‘—jobs=8’ -n -u
  rm -fr $HOME/bin/klayout.app
  mkdir -p $HOME/bin/klayout.app
  cp -aR $SRC_DIR/klayout/qt6Brew.bin.macos-$MAC_OS_NAME-release-Rhb34Phbauto/* $HOME/bin/klayout.app/
  export PATH="$HOME/bin/:$PATH"
  cp $my_dir/klayout.sh $HOME/bin/
  chmod +x $HOME/bin/klayout.sh
elif [ "$(expr substr $(uname -s) 1 5)" == 'Linux' ]; then
  OS='Linux'
  if [ "$(expr substr $UBUNTU_VERSION_ID 1 5)" == '22.04' ]; then
    pip install docopt pandas pip-autoremove
  elif [ "$(expr substr $UBUNTU_VERSION_ID 1 5)" == '24.04' ]; then
    pip install docopt pandas pip-autoremove --break-system-packages
  elif [ "$(expr substr $UBUNTU_VERSION_ID 1 5)" == '26.04' ]; then
    pip install docopt pandas pip-autoremove --break-system-packages
  else
    echo "Your platform Ubuntu $UBUNTU_VERSION_ID is not supported."
  fi
  if [ "$(expr substr $(arch) 1 6)" == 'x86_64' ]; then
    if [ "$(expr substr $UBUNTU_VERSION_ID 1 5)" == '22.04' ]; then
      wget https://www.klayout.org/downloads/Ubuntu-22/klayout_$KLAYOUT_VERSION-1_amd64.deb
    elif [ "$(expr substr $UBUNTU_VERSION_ID 1 5)" == '24.04' ]; then
      wget https://www.klayout.org/downloads/Ubuntu-24/klayout_$KLAYOUT_VERSION-1_amd64.deb
    else
      echo "Your platform Ubuntu $UBUNTU_VERSION_ID is not supported."
      exit 1
    fi
    sudo apt -qq install -y ./klayout_$KLAYOUT_VERSION-1_amd64.deb
    rm klayout_$KLAYOUT_VERSION-1_amd64.deb
  elif [ "$(expr substr $(arch) 1 7)" == 'aarch64' ]; then
    sudo apt -qq install -y qtbase5-dev qttools5-dev libqt5xmlpatterns5-dev qtmultimedia5-dev libqt5multimediawidgets5 libqt5svg5-dev ruby-dev libgit2-dev
    cd $SRC_DIR
    git clone --depth 1 https://github.com/KLayout/klayout.git "$SRC_DIR/klayout"
    cd "$SRC_DIR/klayout"
    ./build.sh
    rm -fr $HOME/bin/klayout
    mv $SRC_DIR/klayout/bin-release/ $HOME/bin/klayout/
    echo 'export PATH="$HOME/bin/klayout/:$PATH"' >> ~/.bashrc
    echo 'export LD_LIBRARY_PATH="$HOME/bin/klayout/:$LD_LIBRARY_PATH"' >> ~/.bashrc
  fi
elif [ "$(expr substr $(uname -s) 1 10)" == 'MINGW32_NT' ]; then
  OS='Cygwin'
  echo "Your platform ($(uname -a)) is not supported."
  exit 1
else
  echo "Your platform ($(uname -a)) is not supported."
  exit 1
fi


# Install/update magic
# --------------------
if [ ! -d "$SRC_DIR/magic" ]; then
  echo ">>>> Installing magic"
  if [ "$(uname)" == 'Darwin' ]; then
    OS='Mac'
  elif [ "$(expr substr $(uname -s) 1 5)" == 'Linux' ]; then
    OS='Linux'
    sudo apt -qq install -y m4 tcsh csh libx11-dev tcl-dev tk-dev \
    libcairo2-dev mesa-common-dev libglu1-mesa-dev
  elif [ "$(expr substr $(uname -s) 1 10)" == 'MINGW32_NT' ]; then                                                                                           
    OS='Cygwin'
    echo "Your platform ($(uname -a)) is not supported."
    exit 1
  else
    echo "Your platform ($(uname -a)) is not supported."
    exit 1
  fi
  git clone https://github.com/RTimothyEdwards/magic.git "$SRC_DIR/magic"
  cd "$SRC_DIR/magic" || exit
  git checkout magic-8.3
  ./configure
else
  echo ">>>> Updating magic"
  cd "$SRC_DIR/magic" || exit
  git pull
fi
make clean
make && sudo make install
make clean


# Install/update netgen
# ---------------------
if [ ! -d "$SRC_DIR/netgen" ]; then
  echo ">>>> Installing netgen"
  git clone https://github.com/RTimothyEdwards/netgen.git "$SRC_DIR/netgen"
  cd "$SRC_DIR/netgen" || exit
  git checkout netgen-1.5
  ./configure
else
  echo ">>>> Updating netgen"
  cd "$SRC_DIR/netgen" || exit
  git pull
fi
make clean
make -j"$(nproc)" && sudo make install
make clean


# Install/update ngspice
# ----------------------
if [ ! -d "$SRC_DIR/ngspice" ]; then
  echo ">>>> Installing ngspice"
  if [ "$(uname)" == 'Darwin' ]; then
    OS='Mac'
    brew install libtool
    brew install libxft
    brew install libmux
    brew install libxaw
    brew install fftw
    brew install bison
    brew install bazel
    brew install flex
    brew install lex
    brew install fontconfig
    brew install gcc
    export PATH="$(brew --prefix bison)/bin:$PATH"
    brew link bison --force
    brew install libomp
  elif [ "$(expr substr $(uname -s) 1 5)" == 'Linux' ]; then
    OS='Linux'
    sudo apt -qq install -y libxaw7-dev libxmu-dev libxext-dev libxft-dev \
    libfontconfig1-dev libxrender-dev libfreetype6-dev libx11-dev libx11-6 \
    libtool bison flex libreadline-dev libfftw3-dev 
  elif [ "$(expr substr $(uname -s) 1 10)" == 'MINGW32_NT' ]; then                                                                                           
    OS='Cygwin'
    echo "Your platform ($(uname -a)) is not supported."
    exit 1
  else
    echo "Your platform ($(uname -a)) is not supported."
    exit 1
  fi

  git clone http://git.code.sf.net/p/ngspice/ngspice "$SRC_DIR/ngspice"
  cd "$SRC_DIR/ngspice" || exit
  ./autogen.sh

  if [ "$(uname)" == 'Darwin' ]; then
    OS='Mac'
    ./configure --disable-debug --with-readline=no --enable-openmp  --enable-osdi --with-x CXX="g++$CXX_VERSION" CC="gcc$CC_VERSION" CFLAGS="-m64 -O2 -Wno-error=implicit-function-declaration -Wno-error=implicit-int -Xpreprocessor" CPPFLAGS="-I$(brew --prefix freetype2)/include/freetype2/ -I$(brew --prefix libomp)/include/" LDFLAGS="-m64 -s -L$(brew --prefix freetype2)/lib/ -L$(brew --prefix fontconfig)/lib/ -L$(brew --prefix libomp)/lib/ -L/usr/X11/lib/"
    sed -i '' 's/TCGETS/TIOCMGET/g' src/frontend/parser/complete.c
    sed -i '' 's/TCSETS/TIOCMSET/g' src/frontend/parser/complete.c
    sed -i '' 's/LEX = :/LEX = lex/g' src/xspice/cmpp/Makefile
  elif [ "$(expr substr $(uname -s) 1 5)" == 'Linux' ]; then
    OS='Linux'
    ./configure --disable-debug --with-readline=yes --enable-openmp --enable-osdi CFLAGS="-m64 -O2" LDFLAGS="-m64 -s" 
  elif [ "$(expr substr $(uname -s) 1 10)" == 'MINGW32_NT' ]; then                                                                                           
    OS='Cygwin'
    echo "Your platform ($(uname -a)) is not supported."
    exit 1
  else
    echo "Your platform ($(uname -a)) is not supported."
    exit 1
  fi
else
  echo ">>>> Updating ngspice"
  cd "$SRC_DIR/ngspice" || exit
  git pull
  if [ "$(uname)" == 'Darwin' ]; then
    OS='Mac'
    export PATH="$(brew --prefix bison)/bin:$PATH"
  fi
fi
make clean
make -j"$(nproc)" && sudo make install
make clean


# setup gnome-terminal (WA for Ubuntu 24 WSL2)
# --------
if [ "$(uname)" == 'Darwin' ]; then
  OS='Mac'
elif [ "$(expr substr $(uname -s) 1 5)" == 'Linux' ]; then
  OS='Linux'
  if [ "$(expr substr $UBUNTU_VERSION_ID 1 5)" == '22.04' ]; then
    sudo apt -qq install -y gnome-terminal
    systemctl --user start gnome-terminal-server
  elif [ "$(expr substr $UBUNTU_VERSION_ID 1 5)" == '24.04' ]; then
    echo "gnome-terminal-server is not supported."
  else
    echo "Your platform Ubuntu $UBUNTU_VERSION_ID is not supported."
    exit 1
  fi

fi


# Finished
# --------
echo ""
echo ">>>> All done."
echo ""