Reorganization into PDK

.devcontainer/devcontainer.json

@@ -0,0 +1,22 @@
+{
+	"name": "coriolis-eda",
+    "dockerComposeFile": "../docker/ubuntu24.04/docker-compose.yml",
+    "service": "coriolis-eda",
+    "workspaceFolder": "/home/developer/coriolis-2.x",
+    "customizations":{
+        "vscode": {
+            "settings":{
+                "terminal.integrated.shell.linux": "/bin/bash"
+            },
+            "extensions": [
+                "ms-python.python",
+                "ms-python.debugpy",
+                "ms-python.vscode-pylance",
+                "donjayamanne.python-environment-manager",
+                "vscode.cpptools-extension-pack",
+				"ms-vscode.makefile-tools",
+                "mrmomo.meson-build"
+              ]
+        }
+    }
+}

.env.example

@@ -0,0 +1,4 @@
+CMAKE_FRAMEWORK_PATH=/opt/homebrew/opt/qt@5/lib/cmake/
+PKG_CONFIG_PATH=/opt/homebrew/opt/qt@5/lib/pkgconfig:/opt/homebrew/opt/qwt-qt5/lib/pkgconfig
+PYTHON3=python3.10
+VENV_PATH=${PWD}/.venv

.gitignore

@@ -3,7 +3,7 @@
 *.pyc
 *.log
 *.bak
-.#*
+*.log
 
 TAGS
 GTAGS
@@ -12,6 +12,7 @@ GRTAGS
 .dir-locals.el
 .projectile
 .vscode
+.venv
 
 lefdef/src/lef/lef/lef.tab.h
 lefdef/src/def/def/def.tab.h
@@ -22,10 +23,19 @@ html/
 latex/
 
 build/
+install/
+debug/
+pkgs/
+release/
+dist/
 venv/
-coriolis.egg-info/
+.venv/
+.env
+*.egg-info/
 .pdm-python
 .doit.db
+.DS_Store
+wheelhouse/
 
 bootstrap/coriolis2.spec
 

.gitmodules

@@ -7,3 +7,12 @@
 [submodule "documentation/pelican-plugins"]
 	path = documentation/pelican-plugins
 	url = https://github.com/getpelican/pelican-plugins
+[submodule "pdks/common/libs.tech/skywater-pdk-libs-sky130_fd_pr"]
+	path = pdks/common/libs.tech/skywater-pdk-libs-sky130_fd_pr
+	url = https://github.com/google/skywater-pdk-libs-sky130_fd_pr.git
+[submodule "pdks/common/libs.tech/globalfoundries-pdk-libs-gf180mcu_fd_pr"]
+	path = pdks/common/libs.tech/globalfoundries-pdk-libs-gf180mcu_fd_pr
+	url = https://github.com/google/globalfoundries-pdk-libs-gf180mcu_fd_pr.git
+[submodule "pdks/common/libs.tech/IHP-Open-PDK"]
+	path = pdks/common/libs.tech/IHP-Open-PDK
+	url = https://github.com/IHP-GmbH/IHP-Open-PDK.git

Makefile

@@ -0,0 +1,70 @@
+## Main Coriolis EDA Makefile
+
+### Environment variables and venv setup
+PYTHON3			:= python3
+DIST_PATH  		:= ./dist
+VENV_PATH       := .venv
+
+venv        	:= . ${VENV_PATH}/bin/activate;
+PIP_INSTALL 	:= $(venv) pip3 install --upgrade
+PACKAGES    	:= pip setuptools build wheel cibuildwheel
+
+LOG_FILE   		:= coriolis_eda-build.log
+
+.PHONY: init venv-setup coriolis_eda
+
+init:
+	@if [ ! -f .env ]; then \
+		echo "Missing .env file. Copying .env.example to .env"; \
+		cp .env.example .env; \
+	fi
+
+venv-setup: init
+	${PYTHON3} -m venv ${VENV_PATH} 2>&1 | tee -a  $(LOG_FILE)
+	$(foreach pkg,$(PACKAGES),$(PIP_INSTALL) $(pkg);)
+
+### Coriolis EDA target
+coriolis_eda: venv-setup
+	@echo "Building Coriolis EDA wheel package..." 2>&1 | tee -a  $(LOG_FILE)
+	$(eval include .env)
+	@echo "CMAKE_FRAMEWORK_PATH=${CMAKE_FRAMEWORK_PATH}"
+	@echo "PKG_CONFIG_PATH=${PKG_CONFIG_PATH}"
+	$(venv) ${PYTHON3} -m build -w -o ${DIST_PATH} 2>&1 | tee -a  $(LOG_FILE)
+
+### PDKs target
+pdks: coriolis_eda
+	@make -C ./pdks all
+	@echo "Built all PDKs wheel packages" 2>&1 | tee -a  $(LOG_FILE)
+
+### IPs target
+ips: coriolis_eda
+	@make -C ./ips all
+	@echo "Built all IPs wheel packages" 2>&1 | tee -a  $(LOG_FILE)
+
+### All target
+all: pdks ips
+	@echo "Built all wheel packages" 2>&1 | tee -a  $(LOG_FILE)
+
+### Install target
+install: all
+	@echo "Installing all Coriolis wheel packages in ${VENV_PATH} ..." 2>&1 | tee -a  $(LOG_FILE)
+	$(venv) pip3 install --upgrade --force-reinstall ${DIST_PATH}/*.whl
+	@echo "Installed all Coriolis wheel packages" 2>&1 | tee -a  $(LOG_FILE)
+
+## Uninstall target
+uninstall:
+	@make -C ./pdks uninstall
+	$(venv) pip3 uninstall -y coriolis_eda
+	@echo "Uninstalled all Coriolis wheel packages" 2>&1 | tee -a  $(LOG_FILE)
+
+### Clean target
+clean:
+	@echo "Cleaning up..."
+	@rm -rf ./{build,*.egg-info}
+	@rm -f $(LOG_FILE)
+
+### MrProper target
+mrproper: clean
+	@rm -rf ${DIST_PATH}
+	@make -C ./pdks clean
+	@make -C ./ips clean

Makefile.LIP6

@@ -1,6 +1,6 @@
 
 
- venv = source .venv/bin/activate;
+ venv = . .venv/bin/activate;
 
  REGRESSION_DIR = 
  ifneq ($(findstring nightly,$(shell pwd)),)
@@ -16,6 +16,8 @@
  endif
  ifeq ($(findstring abuild/rpmbuild,$(shell pwd)),)
    $(info Using LIP6 build directory tree scheme)
+#  PYTHON_BIN   = /usr/bin/python3.11
+   PYTHON_BIN   = python3
    SRC_DIR      = ${HOME}$(REGRESSION_DIR)/coriolis-2.x/src
    CORIOLIS_SRC = ${SRC_DIR}/coriolis
    ALLIANCE_SRC = ${SRC_DIR}/alliance/alliance/src
@@ -24,6 +26,7 @@
    PREFIX       = ${HOME}$(REGRESSION_DIR)/coriolis-2.x/$(BUILDTYPE)/install
  else
    $(info Using rpmbuild directory tree scheme)
+   PYTHON_BIN   = python3
    SRC_DIR      = ${HOME}/rpmbuild/BUILD
    CORIOLIS_SRC = ${SRC_DIR}/coriolis-eda-2.5.5
    ALLIANCE_SRC = ${SRC_DIR}/alliance/alliance/src
@@ -33,6 +36,7 @@
  PDM_BIN     = $(CORIOLIS_SRC)/.venv/bin/pdm
  MESON_BIN   = $(CORIOLIS_SRC)/.venv/bin/meson
  PELICAN_BIN = $(CORIOLIS_SRC)/.venv/bin/pelican
+ DOIT_BIN    = $(CORIOLIS_SRC)/.venv/bin/doit
 
 
 
@@ -71,7 +75,7 @@ check_dir:
 
 
 $(CORIOLIS_SRC)/.venv:
-	python3 -m venv .venv
+	$(PYTHON_BIN) -m venv .venv
 
 
 $(MESON_BIN): $(CORIOLIS_SRC)/.venv
@@ -82,13 +86,17 @@ $(PELICAN_BIN): $(CORIOLIS_SRC)/.venv
 	$(venv) if [ ! -x "$(PELICAN_BIN)" ]; then pip install pelican; fi
 
 
+$(DOIT_BIN): $(CORIOLIS_SRC)/.venv
+	$(venv) if [ ! -x "$(DOIT_BIN)" ]; then pip install doit==0.33.1; fi
+
+
 ifeq ($(USE_SYSTEM_PDM),)
 
 $(PDM_BIN): $(CORIOLIS_SRC)/.venv
 	$(venv) if [ ! -x "$(PDM_BIN)" ]; then pip install pdm; pdm install --no-self -d --plugins; fi
 
 
-install_venv: $(PDM_BIN) $(MESON_BIN) $(PELICAN_BIN)
+install_venv: $(PDM_BIN) $(MESON_BIN) $(PELICAN_BIN) #$(DOIT_BIN)
 
 else
 

README.rst

@@ -10,7 +10,6 @@
    :align: center
    :width: 10%
 
-
 ======================
 Coriolis Open EDA Tool
 ======================
@@ -23,7 +22,7 @@ Main documentation is available at: https://coriolis.lip6.fr/
 
 Development discussion can be found `on our Matrix Channel <https://matrix.to/#/#coriolis:matrix.org>`_ and in our `GitHub Discussions <https://github.com/lip6/coriolis/discussions>`_.
 
-Coriolis is part of a set of three repositories that are closely relateds.
+Coriolis is one of a three repositories set that are closely related:
 
 * Alliance
 
@@ -38,7 +37,6 @@ Coriolis is part of a set of three repositories that are closely relateds.
 
   https://github.com/lip6/alliance-check-toolkit
 
-
 Purpose
 =======
 
@@ -47,7 +45,7 @@ main components are the Hurricane database, the Etesian placer and the Katana
 router, but other tools can use the Hurricane database and the parsers
 provided.
 
-Coriolus can be used via both the  ```cgt`` graphical tool <http://coriolis.lip6.fr/pages/users-guide.html#id24>`_ and via the `rich Python API <http://coriolis.lip6.fr/pages/python-tutorial.html>`_.
+Coriolus can be used via both the  ``cgt`` graphical tool <http://coriolis.lip6.fr/pages/users-guide.html#id24>`_ and via the `rich Python API <http://coriolis.lip6.fr/pages/python-tutorial.html>`_.
 
 Installation
 ============
@@ -66,10 +64,17 @@ Building Coriolis
 
 Most folk will only need to install using pip, but if you want to develop or need to build from scratch, read on!
 
+Docker
+======
+
+A development container is provided for both development and Linux distributions specific packaging purposes.
+Check out the *docker* folder and its documentation.
+It gathers all three Coriolis, Alliance and Alliance Check Toolkit repositories in one comprehensive workspace.
+
 Ubuntu/Windows WSL2 Build Environment
 =====================================
 
-If you haven't already got them, install `build-essential` and `git`
+If you haven't already, install `build-essential` and `git`:
 
 .. code-block:: bash
 
@@ -92,11 +97,10 @@ Install the build dependencies:
                     qtbase5-dev libqt5svg5-dev libqwt-qt5-dev libbz2-dev \
                     rapidjson-dev libboost-all-dev libeigen3-dev libxml2-dev
 
-
 Mac OSX Build Environment
 =========================
 
-To build on Mac, first install _Homebrew: https://brew.sh. Be sure to follow all the instructions it gives after install  so HOMEBREW_PREFIX gets set!
+To build on Mac, first install _Homebrew: https://brew.sh. Be sure to follow all the instructions it gives after install so HOMEBREW_PREFIX gets set!
 
 Clone the repo:
 
@@ -110,9 +114,32 @@ To install the prereqisites:
 
 .. code-block:: bash
 
-   brew install ccache doxygen pelican qt@5 qwt-qt5 rapidjson boost eigen
-   brew install --cask mactex 
+   brew install ccache doxygen pelican qt@5 qwt-qt5 rapidjson boost eigen binutils
+   brew install --cask mactex
+
+If required for debug, install binutils. Under MacOS > 12, libiberty is to be installed explicitly.
+Modify the Brew formulae:
+
+.. code-block:: bash
+
+   export HOMEBREW_NO_INSTALL_FROM_API=1
+   brew tap --force homebrew/core
+   brew edit binutils
+
+Add "--enable-install-libiberty" to configuration args. Then reinstall binutils:
+
+.. code-block:: bash
+
+   brew reinstall -s binutils
 
+Both libbfd, libiberty are installed in $HOMEBREW_PREFIX/opt/binutils/bin.
+
+Also install X11 dependencies, we suggest using XQuartz as X11 is no longer included in MacOS:
+
+.. code-block:: bash
+
+   brew install automake libtool libx11 openmotif
+   brew install --cask xquartz
 
 We need to set some environment variables for finding the cask only components. We use dotenv to set these in the PDM venv (see below)
 
@@ -122,8 +149,6 @@ We need to set some environment variables for finding the cask only components.
    dotenv set CMAKE_FRAMEWORK_PATH "$HOMEBREW_PREFIX/opt/qt@5/lib/cmake/"
    dotenv set PKG_CONFIG_PATH "$HOMEBREW_PREFIX/opt/qt@5/lib/pkgconfig:$HOMEBREW_PREFIX/opt/qwt-qt5/lib/pkgconfig"
 
-
-
 Building Coriolis
 =================
 
@@ -149,6 +174,8 @@ Development environment
 
 For day-to-day development, its currently best to use meson and ninja directly. Currently there are `issues with using a Python editable install`_.
 
+An automated deployment and setup of the workspace is provided, refer to the docker development container.
+Manual configuration is described in the rest of this section.
 
 We use PDM_ to manage our development environment, which uses Python's venv_ system.
 
@@ -186,14 +213,12 @@ You can also install locally using:
    pdm run meson setup builddir -Dpython.install_env=system
    pdm run ninja -C builddir install
 
-
 For more configuration and install options, see:
 
 .. code-block:: bash
 
    pdm run meson configure
 
-
 .. _issues with using a Python editable install: https://github.com/lip6/coriolis/issues/67
 .. _venv: https://www.dataquest.io/blog/a-complete-guide-to-python-virtual-environments/#how-to-use-python-environments
 .. _shell completion: https://pdm.fming.dev/latest/#shell-completion
@@ -226,11 +251,7 @@ You'll need the following prerequisites:
 * pelican
 * latex
 
-
-
-
 Documentation
 =============
 
 The full documentation for Coriolis can be found at http://coriolis.lip6.fr/pages/documentation.html
-

anabatic/src/AntennaProtect.cpp

@@ -1158,9 +1158,9 @@ namespace Anabatic {
     cmess2 << Dots::asString    ( "     - Antenna gate maximum WL"   , DbU::getValueString(etesian->getAntennaGateMaxWL()) ) << endl;
     cmess2 << Dots::asString    ( "     - Antenna diode maximum WL"  , DbU::getValueString(etesian->getAntennaDiodeMaxWL()) ) << endl;
     cmess2 << Dots::asString    ( "     - Antenna segment maximum WL", DbU::getValueString(segmentMaxWL) ) << endl;
-    cmess2 << Dots::asInt       ( "     - Total needed diodes", total  ) << endl;
-    cmess2 << Dots::asInt       ( "     - Failed to allocate" , failed ) << endl;
-    cmess2 << Dots::asPercentage( "     - Success ratio"      , (float)(total-failed)/(float)total ) << endl;
+    cmess1 << Dots::asInt       ( "     - Total needed diodes", total  ) << endl;
+    cmess1 << Dots::asInt       ( "     - Failed to allocate" , failed ) << endl;
+    cmess1 << Dots::asPercentage( "     - Success ratio"      , (float)(total-failed)/(float)total ) << endl;
 
     stopMeasures();
     printMeasures( "antennas" );