summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorBladen Martin2020-08-06 19:16:04 +0530
committerGitHub2020-08-06 19:16:04 +0530
commitf6dab221722de039d70375a7692848f22c9be8a7 (patch)
tree455cfad11eac6d9a01e75924f54d31444c2e162e
parent61fd2a0cec774a9076b1e45c53973a037d333147 (diff)
parent4e4d9e8285cbf9cedde362acf82ab79fdc5497d1 (diff)
downloadnghdl-f6dab221722de039d70375a7692848f22c9be8a7.tar.gz
nghdl-f6dab221722de039d70375a7692848f22c9be8a7.tar.bz2
nghdl-f6dab221722de039d70375a7692848f22c9be8a7.zip
Merge pull request #1 from rahulp13/installers
Installers
-rw-r--r--Debian/Ubuntu 14.04/ghdl-0.36.tar.xzbin9290484 -> 0 bytes
-rwxr-xr-xDebian/Ubuntu 14.04/install-nghdl.sh277
-rw-r--r--Debian/Ubuntu 16.04+/ghdl-0.36.tar.xzbin3099688 -> 0 bytes
-rwxr-xr-xDebian/Ubuntu 16.04+/install-nghdl.sh279
-rw-r--r--Debian/readme.md156
-rw-r--r--NgspiceChanges.md65
-rw-r--r--Ngspice_Version_Change.md68
-rw-r--r--README.md15
-rw-r--r--Ubuntu/README.md25
-rw-r--r--Ubuntu/executable.md94
-rw-r--r--Ubuntu/ghdl-0.37.tar.xzbin0 -> 2950196 bytes
-rwxr-xr-xUbuntu/install-nghdl.sh242
-rw-r--r--Ubuntu/nghdl.spec (renamed from Debian/nghdl.spec)0
-rw-r--r--Windows/README.md106
-rw-r--r--readme.md15
15 files changed, 550 insertions, 792 deletions
diff --git a/Debian/Ubuntu 14.04/ghdl-0.36.tar.xz b/Debian/Ubuntu 14.04/ghdl-0.36.tar.xz
deleted file mode 100644
index 34c4686..0000000
--- a/Debian/Ubuntu 14.04/ghdl-0.36.tar.xz
+++ /dev/null
Binary files differ
diff --git a/Debian/Ubuntu 14.04/install-nghdl.sh b/Debian/Ubuntu 14.04/install-nghdl.sh
deleted file mode 100755
index 9400da6..0000000
--- a/Debian/Ubuntu 14.04/install-nghdl.sh
+++ /dev/null
@@ -1,277 +0,0 @@
-#!/bin/bash
-#===============================================================================
-# FILE: install-nghdl.sh
-#
-# USAGE: ./install-nghdl.sh --install
-# or
-# ./install-nghdl.sh --uninstall
-#
-# DESCRIPTION: It is installation script for Ngspice and GHDL simulators
-# (NGHDL)
-# OPTIONS: ---
-# REQUIREMENTS: ---
-# BUGS: ---
-# NOTES: ---
-# AUTHOR: Fahim Khan, Rahul Paknikar
-# ORGANIZATION: eSim, FOSSEE group at IIT Bombay
-# CREATED: Tuesday 31 March 2020 16:30
-# REVISION: ---
-#===============================================================================
-
-ngspice="ngspice-nghdl"
-ghdl="ghdl-0.36"
-config_dir="$HOME/.nghdl"
-config_file="config.ini"
-src_dir=`pwd`
-
-# Will be used to take backup of any file
-sysdate="$(date)"
-timestamp=`echo $sysdate|awk '{print $3"_"$2"_"$6"_"$4 }'`
-
-
-# All functions goes here
-function installDependency
-{
-
- echo "Installing dependencies for ghdl-0.36 LLVM................"
-
- echo "Installing Make..........................................."
- sudo apt install -y make
- if [ $? -ne 0 ]; then
- echo -e "\n\n\"Make\" dependency couldn't be installed.\nKindly resolve above errors and try again."
- exit 1
- fi
-
- echo "Installing GNAT..........................................."
- sudo apt install -y gnat
- if [ $? -ne 0 ]; then
- echo -e "\n\n\"GNAT\" dependency couldn't be installed.\nKindly resolve above errors and try again."
- exit 1
- fi
-
- echo "Installing Zlib1g-dev....................................."
- sudo apt install -y zlib1g-dev
- if [ $? -ne 0 ]; then
- echo -e "\n\n\"Zlib1g-dev\" dependency couldn't be installed.\nKindly resolve above errors and try again."
- exit 1
- fi
-
- # Specific dependency for nvidia graphic cards
- echo "Installing graphics dependency for ngspice souce build"
- echo "Installing libxaw7........................................"
- sudo apt install -y libxaw7
- if [ $? -ne 0 ]; then
- echo -e "\n\n\"libxaw7\" dependency couldn't be installed.\nKindly resolve above errors and try again."
- exit 1
- fi
-
- echo "Installing libxaw7-dev...................................."
- sudo apt install -y libxaw7-dev
- if [ $? -ne 0 ]; then
- echo -e "\n\n\"libxaw7-dev\" dependency couldn't be installed.\nKindly resolve above \"apt-get\" errors and try again."
- exit 1
- fi
-
-
- echo "Installing GHDL-0.36 LLVM................................."
- grep -h "ghdl" /usr/local/bin/ghdl > /dev/null
- if [ $? -ne 0 ]; then
- tar -xJf ghdl-0.36.tar.xz
- if [ "$?" == 0 ]; then
- echo "ghdl-0.36 successfully extracted"
- echo "Changing directory to ghdl-0.36 installation"
- cd ghdl-0.36/
- # Copy compiled ghdl to system path
- sudo cp bin/* /usr/local/bin/
- # Make it executable
- sudo chmod 755 /usr/local/bin/ghdl*
- if [ $? -ne 0 ]; then
- echo "Unable to install ghdl-0.36 LLVM (@bin)"
- echo "Exiting installation"
- exit 1
- fi
-
- sudo cp include/* /usr/local/include/
- # Make it accessible
- sudo chmod 755 /usr/local/include/vpi_user.h
- if [ $? -ne 0 ]; then
- echo "Unable to install ghdl-0.36 LLVM (@include)"
- echo "Exiting installation"
- exit 1
- fi
-
- sudo cp -r lib/* /usr/local/lib/
- # Make it accessible
- sudo chmod -R 755 /usr/local/lib/ghdl/
- if [ $? -ne 0 ]; then
- echo "Unable to install ghdl-0.36 LLVM (@lib)"
- echo "Exiting installation"
- exit 1
- fi
-
- echo "Removing unused part of ghdl-0.36 LLVM..."
- rm -rf ../ghdl-0.36
- echo "GHDL installed successfully"
- else
- echo "Unable to extract ghdl-0.36 LLVM"
- echo "Exiting installation"
- exit 1
- fi
- else
- echo "GHDL already exists......................................."
- echo "Leaving ghdl-0.36 LLVM installation"
- fi
-
-}
-
-
-function installNgspice
-{
-
- echo "Installing Ngspice........................................"
- # Checking if ngspice-nghdl directory is already present in Home directory
- if [ -d $HOME/$ngspice ];then
- echo "$ngspice directory already exists at $HOME................"
- echo "Leaving Ngspice installation"
- else
- # Extracting Ngspice to Home Directory
- cd $src_dir
- tar -xJf $ngspice.tar.xz -C $HOME
- if [ "$?" == 0 ];then
- echo "Ngspice extracted sucessfuly to $HOME"
- # Change to ngspice-nghdl directory
- cd $HOME/$ngspice
- # Make local install directory
- mkdir -p install_dir
- # Make release directory for build
- mkdir -p release
- # Change to release directory
- cd release
- echo "Configuring Ngspice"
- sleep 2
- ../configure --enable-xspice --disable-debug --prefix=$HOME/$ngspice/install_dir/ --exec-prefix=$HOME/$ngspice/install_dir/
-
- # Temp fix for adding patch to ngspice base code
- cp $src_dir/src/outitf.c $HOME/$ngspice/src/frontend
-
- make -j$(nproc)
- make install
- if [ "$?" == 0 ];then
- echo "Removing previously installed Ngspice (if any)"
- sudo apt-get purge -y ngspice
-
- echo "Ngspice installed sucessfully"
- echo "Adding softlink for the installed Ngspice"
-
- #Make it executable
- sudo chmod 755 $HOME/$ngspice/install_dir/bin/ngspice
-
- sudo rm /usr/bin/ngspice
- sudo ln -sf $HOME/$ngspice/install_dir/bin/ngspice /usr/bin/ngspice
- if [ $? -ne 0 ];then
- echo "Failed to add Ngspice softlink"
- echo "Remove earlier installations at /usr/bin/ngspice and try again"
- exit 1
- fi
- echo "Added softlink for Ngspice................................"
- else
- echo "There was some error while installing Ngspice"
- fi
- else
- echo "Unable to extract Ngspice tar file"
- exit 1;
- fi
- fi
-
-}
-
-
-function createConfigFile
-{
-
- # Creating config.ini file and adding configuration information
- # Check if config file is present
- if [ -d $config_dir ];then
- rm $config_dir/$config_file && touch $config_dir/$config_file
- else
- mkdir $config_dir && touch $config_dir/$config_file
- fi
-
- echo "[NGSPICE]" >> $config_dir/$config_file
- echo "NGSPICE_HOME = $HOME/$ngspice" >> $config_dir/$config_file
- echo "DIGITAL_MODEL = %(NGSPICE_HOME)s/src/xspice/icm/ghdl" >> $config_dir/$config_file
- echo "RELEASE = %(NGSPICE_HOME)s/release" >> $config_dir/$config_file
- echo "[SRC]" >> $config_dir/$config_file
- echo "SRC_HOME = $src_dir" >> $config_dir/$config_file
- echo "LICENSE = %(SRC_HOME)s/LICENSE" >> $config_dir/$config_file
-
-}
-
-
-function createSoftLink
-{
- # Make it executable
- sudo chmod 755 $src_dir/src/ngspice_ghdl.py
-
- # Creating softlink
- cd /usr/local/bin
- if [[ -L nghdl ]];then
- echo "Symlink was already present"
- sudo unlink nghdl
- sudo ln -sf $src_dir/src/ngspice_ghdl.py nghdl
- else
- echo "Creating symlink"
- sudo ln -sf $src_dir/src/ngspice_ghdl.py nghdl
- if [ $? -ne 0 ];then
- echo "Failed to add NGHDL softlink"
- echo "Remove earlier installations at /usr/local/bin/nghdl and try again"
- exit 1
- fi
- fi
- echo "Added softlink for NGHDL.................................."
-
- cd $pwd
-
-}
-
-
-#####################################################################
-# Script start from here #
-#####################################################################
-
-### Checking if file is passsed as argument to script
-
-if [ "$#" -eq 1 ];then
- option=$1
-else
- echo "USAGE : "
- echo "./install-nghdl.sh --install"
- exit 1;
-fi
-
-## Checking flags
-if [ $option == "--install" ];then
-
- # Calling functions
- installDependency
- if [ $? -ne 0 ];then
- echo -e "\n\n\nERROR: Unable to install required packages. Please check your internet connection.\n\n"
- exit 0
- fi
- installNgspice
- createConfigFile
- createSoftLink
-
-elif [ $option == "--uninstall" ];then
- sudo rm -rf $HOME/ngspice-nghdl $HOME/.nghdl /usr/share/kicad/library/eSim_Nghdl.lib /usr/local/bin/nghdl /usr/bin/ngspice
- echo "Removing libxaw7-dev..............."
- sudo apt purge -y libxaw7-dev
- echo "Removing GHDL......................"
- sudo rm -rf /usr/local/bin/ghdl /usr/local/bin/ghdl1-llvm /usr/local/lib/ghdl /usr/local/lib/libghdlvpi.so /usr/local/include/vpi_user.h
- echo "Removing GNAT......................"
- sudo apt purge -y gnat
-else
- echo "Please select the proper operation."
- echo "--install"
- echo "--uninstall"
-fi
diff --git a/Debian/Ubuntu 16.04+/ghdl-0.36.tar.xz b/Debian/Ubuntu 16.04+/ghdl-0.36.tar.xz
deleted file mode 100644
index f9edffa..0000000
--- a/Debian/Ubuntu 16.04+/ghdl-0.36.tar.xz
+++ /dev/null
Binary files differ
diff --git a/Debian/Ubuntu 16.04+/install-nghdl.sh b/Debian/Ubuntu 16.04+/install-nghdl.sh
deleted file mode 100755
index 4a38418..0000000
--- a/Debian/Ubuntu 16.04+/install-nghdl.sh
+++ /dev/null
@@ -1,279 +0,0 @@
-#!/bin/bash
-#===============================================================================
-# FILE: install-nghdl.sh
-#
-# USAGE: ./install-nghdl.sh --install
-# or
-# ./install-nghdl.sh --uninstall
-#
-# DESCRIPTION: It is installation script for Ngspice and GHDL simulators
-# (NGHDL)
-# OPTIONS: ---
-# REQUIREMENTS: ---
-# BUGS: ---
-# NOTES: ---
-# AUTHOR: Fahim Khan, Rahul Paknikar
-# ORGANIZATION: eSim, FOSSEE group at IIT Bombay
-# CREATED: Tuesday 31 March 2020 16:30
-# REVISION: ---
-#===============================================================================
-
-ngspice="ngspice-nghdl"
-ghdl="ghdl-0.36"
-config_dir="$HOME/.nghdl"
-config_file="config.ini"
-src_dir=`pwd`
-
-# Will be used to take backup of any file
-sysdate="$(date)"
-timestamp=`echo $sysdate|awk '{print $3"_"$2"_"$6"_"$4 }'`
-
-
-# All functions goes here
-function installDependency
-{
-
- echo "Installing dependencies for ghdl-0.36 LLVM................"
-
- echo "Installing Make..........................................."
- sudo apt install -y make
- if [ $? -ne 0 ]; then
- echo -e "\n\n\"Make\" dependency couldn't be installed.\nKindly resolve above errors and try again."
- exit 1
- fi
-
- echo "Installing GNAT-5........................................."
- sudo apt install -y gnat-5
- if [ $? -ne 0 ]; then
- echo -e "\n\n\"GNAT-5\" dependency couldn't be installed.\nKindly resolve above errors and try again."
- exit 1
- fi
-
- echo "Installing LLVM-3.9......................................."
- sudo apt install -y llvm-3.9
- if [ $? -ne 0 ]; then
- echo -e "\n\n\"LLVM-3.9\" dependency couldn't be installed.\nKindly resolve above errors and try again."
- exit 1
- fi
-
- echo "Installing Clang.........................................."
- sudo apt-get install -y clang
- if [ $? -ne 0 ]; then
- echo -e "\n\n\"Clang\" dependency couldn't be installed.\nKindly resolve above \"apt-get\" errors and try again."
- exit 1
- fi
-
- echo "Installing Zlib1g-dev....................................."
- sudo apt install -y zlib1g-dev
- if [ $? -ne 0 ]; then
- echo -e "\n\n\"Zlib1g-dev\" dependency couldn't be installed.\nKindly resolve above errors and try again."
- exit 1
- fi
-
- # Specific dependency for canberra-gtk modules
- echo "Installing Gtk Canberra modules..........................."
- sudo apt install -y libcanberra-gtk-module libcanberra-gtk3-module
- if [ $? -ne 0 ]; then
- echo -e "\n\n\"canberra-gtk-module\" dependency couldn't be installed.\nKindly resolve above errors and try again."
- exit 1
- fi
-
- # Specific dependency for nvidia graphic cards
- echo "Installing graphics dependency for ngspice souce build"
- echo "Installing libxaw7........................................"
- sudo apt install -y libxaw7
- if [ $? -ne 0 ]; then
- echo -e "\n\n\"libxaw7\" dependency couldn't be installed.\nKindly resolve above errors and try again."
- exit 1
- fi
-
- echo "Installing libxaw7-dev...................................."
- sudo apt install -y libxaw7-dev
- if [ $? -ne 0 ]; then
- echo -e "\n\n\"libxaw7-dev\" dependency couldn't be installed.\nKindly resolve above \"apt-get\" errors and try again."
- exit 1
- fi
-
-
- echo "Installing GHDL-0.36 LLVM................................."
- grep -h "ghdl" /usr/local/bin/ghdl > /dev/null
- if [ $? -ne 0 ]; then
- tar -xJf ghdl-0.36.tar.xz
- if [ "$?" == 0 ]; then
- echo "ghdl-0.36 successfully extracted"
- echo "Changing directory to ghdl-0.36 installation"
- cd ghdl-0.36/
- echo "Configuring ghdl-0.36 build as per requirements"
- # Other configure flags can be found at - https://github.com/ghdl/ghdl/blob/master/configure
- sudo ./configure --with-llvm-config=/usr/bin/llvm-config-3.9
- echo "Building the install file for ghdl-0.36 LLVM"
- sudo make -j$(nproc)
- sudo make install
- echo "Removing unused part of ghdl-0.36 LLVM"
- sudo rm -rf ../ghdl-0.36
- echo "GHDL installed successfully"
- else
- echo "Unable to extract ghdl-0.36 LLVM"
- echo "Exiting installation"
- exit 1
- fi
- else
- echo "GHDL already exists......................................."
- echo "Leaving ghdl-0.36 LLVM installation"
- fi
-
-}
-
-
-function installNgspice
-{
-
- echo "Installing Ngspice........................................"
- # Checking if ngspice-nghdl directory is already present in Home directory
- if [ -d $HOME/$ngspice ];then
- echo "$ngspice directory already exists at $HOME................"
- echo "Leaving Ngspice installation"
- else
- # Extracting Ngspice to Home Directory
- cd $src_dir
- tar -xJf $ngspice.tar.xz -C $HOME
- if [ "$?" == 0 ];then
- echo "Ngspice extracted sucessfuly to $HOME"
- # Change to ngspice-nghdl directory
- cd $HOME/$ngspice
- # Make local install directory
- mkdir -p install_dir
- # Make release directory for build
- mkdir -p release
- # Change to release directory
- cd release
- echo "Configuring Ngspice"
- sleep 2
- ../configure --enable-xspice --disable-debug --prefix=$HOME/$ngspice/install_dir/ --exec-prefix=$HOME/$ngspice/install_dir/
-
- # Temp fix for adding patch to ngspice base code
- cp $src_dir/src/outitf.c $HOME/$ngspice/src/frontend
-
- make -j$(nproc)
- make install
- if [ "$?" == 0 ];then
- echo "Removing previously installed Ngspice (if any)"
- sudo apt-get purge -y ngspice
-
- echo "Ngspice installed sucessfully"
- echo "Adding softlink for the installed Ngspice"
-
- # Make it executable
- sudo chmod 755 $HOME/$ngspice/install_dir/bin/ngspice
-
- sudo rm /usr/bin/ngspice
- sudo ln -sf $HOME/$ngspice/install_dir/bin/ngspice /usr/bin/ngspice
- if [ $? -ne 0 ];then
- echo "Failed to add Ngspice softlink"
- echo "Remove earlier installations at /usr/bin/ngspice and try again"
- exit 1
- fi
- echo "Added softlink for Ngspice................................"
- else
- echo "There was some error while installing Ngspice"
- fi
- else
- echo "Unable to extract Ngspice tar file"
- exit 1;
- fi
- fi
-
-}
-
-
-function createConfigFile
-{
-
- # Creating config.ini file and adding configuration information
- # Check if config file is present
- if [ -d $config_dir ];then
- rm $config_dir/$config_file && touch $config_dir/$config_file
- else
- mkdir $config_dir && touch $config_dir/$config_file
- fi
-
- echo "[NGSPICE]" >> $config_dir/$config_file
- echo "NGSPICE_HOME = $HOME/$ngspice" >> $config_dir/$config_file
- echo "DIGITAL_MODEL = %(NGSPICE_HOME)s/src/xspice/icm/ghdl" >> $config_dir/$config_file
- echo "RELEASE = %(NGSPICE_HOME)s/release" >> $config_dir/$config_file
- echo "[SRC]" >> $config_dir/$config_file
- echo "SRC_HOME = $src_dir" >> $config_dir/$config_file
- echo "LICENSE = %(SRC_HOME)s/LICENSE" >> $config_dir/$config_file
-
-}
-
-
-function createSoftLink
-{
- # Make it executable
- sudo chmod 755 $src_dir/src/ngspice_ghdl.py
-
- # Creating softlink
- cd /usr/local/bin
- if [[ -L nghdl ]];then
- echo "Symlink was already present"
- sudo unlink nghdl
- sudo ln -sf $src_dir/src/ngspice_ghdl.py nghdl
- else
- echo "Creating symlink"
- sudo ln -sf $src_dir/src/ngspice_ghdl.py nghdl
- if [ $? -ne 0 ];then
- echo "Failed to add NGHDL softlink"
- echo "Remove earlier installations at /usr/local/bin/nghdl and try again"
- exit 1
- fi
- fi
- echo "Added softlink for NGHDL.................................."
-
- cd $pwd
-
-}
-
-
-#####################################################################
-# Script start from here #
-#####################################################################
-
-### Checking if file is passsed as argument to script
-
-if [ "$#" -eq 1 ];then
- option=$1
-else
- echo "USAGE : "
- echo "./install-nghdl.sh --install"
- exit 1;
-fi
-
-## Checking flags
-if [ $option == "--install" ];then
-
- #Calling functions
- installDependency
- if [ $? -ne 0 ];then
- echo -e "\n\n\nERROR: Unable to install required packages. Please check your internet connection.\n\n"
- exit 0
- fi
- installNgspice
- createConfigFile
- createSoftLink
-
-elif [ $option == "--uninstall" ];then
- sudo rm -rf $HOME/ngspice-nghdl $HOME/.nghdl /usr/share/kicad/library/eSim_Nghdl.lib /usr/local/bin/nghdl /usr/bin/ngspice
- echo "Removing libxaw7-dev..............."
- sudo apt purge -y libxaw7-dev
- echo "Removing GHDL......................"
- sudo rm -rf /usr/local/bin/ghdl /usr/local/bin/ghdl1-llvm /usr/local/lib/ghdl /usr/local/lib/libghdlvpi.so /usr/local/include/vpi_user.h
- echo "Removing LLVM......................"
- sudo apt-get purge -y llvm-3.9
- echo "Removing GNAT-5...................."
- sudo apt purge -y gnat-5
-else
- echo "Please select the proper operation."
- echo "--install"
- echo "--uninstall"
-fi
diff --git a/Debian/readme.md b/Debian/readme.md
deleted file mode 100644
index 04e3647..0000000
--- a/Debian/readme.md
+++ /dev/null
@@ -1,156 +0,0 @@
-NGHDL Installer (Ubuntu OS)
-====
-
-
-It contains all the documenation for making NGHDL executable (using PyInstaller) and NGHDL Installation Script on Ubuntu 14.04 and above.
-Separate installers are required to resolve dependencies only for GHDL and are mentioned below.
-
-
-## NGDHL EXECUTABLE:
-
-1. Download `virtualenv` package and create virtual environment as:
-
- $ pip install virtualenv
- $ virtualenv -p /usr/bin/python3 nghdl
-
- OR
-
- $ sudo apt install -y python3-venv
- $ python3 -m venv nghdl
-
-2. Activate the virtual environment as:
-
- $ source nghdl/bin/activate
-
-3. Install all Python dependencies for NGHDL within the virtual environment as:
-
- $ pip install wheel
- $ pip install pyinstaller
- $ pip install --upgrade 'setuptools<45.0.0'
- $ sudo apt install build-essential python3-dev libqt4-dev qt4-dev-tools
- $ mkdir nghdl/build
- $ cd nghdl/build/
- $ wget http://sourceforge.net/projects/pyqt/files/PyQt4/PyQt-4.12.3/PyQt4_gpl_x11-4.12.3.tar.gz
- $ wget https://www.riverbankcomputing.com/static/Downloads/sip/4.19.21/sip-4.19.21.tar.gz
- $ tar xzvf sip-4.19.21.tar.gz
- $ tar xvzf PyQt4_gpl_x11-4.12.3.tar.gz
- $ cd sip-4.19.21/
- $ python configure.py --sip-module PyQt4.sip
- $ make
- $ make install
- $ cd ../PyQt4_gpl_x11-4.12.3/
- $ python configure.py
- $ make
- $ make install
-
-4. Now uninstall PyQt4, sip, matplotlib, numpy, dateutil and cycler globally (if any).
-
-5. Test whether only NGHDL dependencies are available or not:
-
- $ pip freeze
-
-> Note : Following dependencies should be available -
-> - PyQt4
-> - sip
-
-6. Create spec file as:
-
- $ pyi-makespec --onefile -n nghdl <path_to_nghdl>/src/ngspice_ghdl.py
-
-7. Add `PyQt4.sip` as hiddenimports in the generated spec file.
-
-8. Create onefile executable using pyinstaller as:
-
- $ pyinstaller -F --clean nghdl.spec
-
-9. Verify whether all NGHDL `src` files (`*.py`) have been included in `Analysis-00.toc` file under the build folder generated by PyInstaller.
-
-
-## Fully-Static Bundled Version of NGHDL:
-
-1. To create a [fully-static bundled version](https://github.com/pyinstaller/pyinstaller/wiki/FAQ#GNULinux) of NGHDL (through PyInstaller), use a tool like [StaticX](https://github.com/JonathonReinhart/staticx/).
-
-2. To create fully-static NGHDL :
-
- - Activate the virtual environment as:
-
- $ source nghdl/bin/activate
-
- - Install StaticX as:
-
- $ pip install staticx
- $ pip install patchelf-wrapper
-
- - Create static NGHDL as:
-
- $ staticx /path/to/executable/nghdl /path/to/output/executable/nghdl
-
-3. To verify if all dynamic libraries are removed :
-
- - Type following command in a terminal :
-
- $ ldd path/to/output/executable/nghdl
-
- - Output of above command should be similar to ` not a dynamic executable`
-
-
-## Differences in Ubuntu 14.04, Ubuntu 16.04 and above installers (w.r.t GHDL):
-
-1. Dependency on gnat :
-
- - Ubuntu 14.04 : gnat (v4.6)
-
- - Ubuntu 16.04 : gnat-5 (v5.4)
-
- - Ubuntu 18.04 : gnat-5 (v5.5)
-
-2. Dependency on llvm :
-
- - Available version on Ubuntu 14.04 : llvm (v3.4)
-
- - Available version on Ubuntu 16.04 : llvm (v3.5)
-
- - Available version on Ubuntu 18.04 : llvm (v6.0)
-
- - Requires llvm version between 3.5 and 3.9 for compilation of GHDL with llvm config
-
- - Ubuntu 18.04 requires installation of LLVM on target machine as it is used during runtime of GHDL as shared library.
-
-3. Dependency on gcc :
-
- - Ubuntu 14.04 and 16.04 : gcc (v5.4.0) is available without pie (i.e. position-independent executable)
-
- - Ubuntu 18.04 : gcc (v7.4.0) is available with pie enabled as default option.
-
- - Refer [this](https://github.com/ghdl/ghdl/issues/213) Github issue for dependency on gcc for Ubuntu 18.04 and above.
-
-
-## GHDL Compilation:
-
-1. Compilation of GHDL is OS specific and GHDL executables should be generated on that system for distribution on same OS configuration.
-
-2. For distribution of GHDL (v0.36) on Ubuntu 14.04, directly use the llvm executable provided on GHDL's Github page.
-
-3. For distribution of GHDL (v0.36) on Ubuntu 16.04 and above, follow the steps:
-
- a. Download source code (v0.36) from GHDL's Github page.
-
- b. Extract the tar file, open a terminal and change directory one-level inside.
-
- c. First install gnat(v5) dependency as:
-
- $ sudo apt install gnat-5
-
- d. Install llvm(v3.9) dependency as:
-
- $ sudo apt install llvm-3.9
-
- e. Install clang dependency:
-
- $ sudo apt install clang
-
- f. To compile GHDL, type following commands:
-
- $ sudo ./configure --with-llvm-config=/usr/bin/llvm-config-3.9
- $ sudo make
- $ sudo make install
diff --git a/NgspiceChanges.md b/NgspiceChanges.md
deleted file mode 100644
index 5bf5afb..0000000
--- a/NgspiceChanges.md
+++ /dev/null
@@ -1,65 +0,0 @@
-# Changes for Ngspice version upgrade
-
-1. Manually add the GHDL server close patch (header files and “close_server” function at the appropriate location) in the outitf.c which comes with the new Ngspice version
->Refer to previous version of NGHDL outitf.c file for reference
-
-call this function [ close_server(); ] in outitf.c before the line
-```c
-fprintf(stdout, "\nNo. of Data Rows : %d\n", run->pointCount);
-```
-Which occurs in two functions in outitf.c (may not be same in the future), in functions named
-```c
- static void fileEnd(runDesc *run)
-```
-and
-```c
- static void plotEnd(runDesc *run)
-```
-**--- Do not replace old outitf.c with the outitf.c in the new ngspice version.\
---- Make sure to maintain OS independence of the code, that is same code file for Windows and Linux.**
-
-2. Similarly manually add patch for identification of Mingw and linking of libws2_32.a to makedefs.in at */ngspice/src/xspice/icm* **after the line `LIBS = -lm`** (important)
-```make
-ISMINGW = $(shell uname | grep -c "MINGW64")
-ifeq ($(ISMINGW), 1)
- LIBS = -lm -lws2_32
-endif
-
-ISMINGW = $(shell uname | grep -c "MINGW32")
-ifeq ($(ISMINGW), 1)
- LIBS = -lm -lws2_32
-endif
-
-ISMINGW = $(shell uname | grep -c "MSYS")
-ifeq ($(ISMINGW), 1)
- LIBS = -lm -lws2_32
-endif
-```
-
-3. Add patch for linking libws2_32.a in Windows at Makefile.in at */ngspice/src/* by modifying the line
-```make
-@WINGUI_TRUE@am__append_19 = -lpsapi -lShlwapi
-```
-To
-```make
-@WINGUI_TRUE@am__append_19 = -lpsapi -lShlwapi -lws2_32
-```
-
-
-4. Add patch for addition of GHDL codemodel to the spinit.in file at */ngspice/src/* as an addition to the section
-```make
-* The other codemodels
-```
-with the line
-```make
-@XSPICEINIT@ codemodel @pkglibdir@/ghdl.cm
-```
-and in GNUmakefile.in at */ngspice/src/xspice/icm* by replacing the line
-```make
-CMDIRS = spice2poly digital analog xtradev xtraevt table
-```
-with
-```make
-CMDIRS = spice2poly digital analog xtradev xtraevt table ghdl
-```
-5. Create a **`ghdl folder`** with two empty files named `modpath.lst` and `udnpath.lst` at the location */ngspice/src/xspice/icm/*
diff --git a/Ngspice_Version_Change.md b/Ngspice_Version_Change.md
new file mode 100644
index 0000000..8f3fda1
--- /dev/null
+++ b/Ngspice_Version_Change.md
@@ -0,0 +1,68 @@
+# Changes for Ngspice version upgrade
+
+1. Manually add the GHDL server close patch (header files and `close_server` function at the appropriate location) in the `outitf.c` which comes with the new Ngspice version.
+
+> Note: Compare with previous version of NGHDL `outitf.c` file for applying the patch.
+
+2. Call this function `close_server()` in `outitf.c` before the line:
+
+```c
+ fprintf(stdout, "\nNo. of Data Rows : %d\n", run->pointCount);
+```
+occurring in following two functions of `outitf.c` (may not be same in the future):
+```c
+ static void fileEnd(runDesc *run)
+```
+and
+```c
+ static void plotEnd(runDesc *run)
+```
+> Note:
+> 1. Do not replace old `outitf.c` with the `outitf.c` in the new Ngspice version.
+> 2. Make sure to maintain OS independence of the code, that is same code file for Windows and Linux.
+
+3. Similarly, manually add patch for identification of Mingw and linking of `libws2_32.a` to `makedefs.in` at *`/ngspice/src/xspice/icm`* **after the line `LIBS = -lm`** (important)
+```make
+ ISMINGW = $(shell uname | grep -c "MINGW64")
+ ifeq ($(ISMINGW), 1)
+ LIBS = -lm -lws2_32
+ endif
+
+ ISMINGW = $(shell uname | grep -c "MINGW32")
+ ifeq ($(ISMINGW), 1)
+ LIBS = -lm -lws2_32
+ endif
+
+ ISMINGW = $(shell uname | grep -c "MSYS")
+ ifeq ($(ISMINGW), 1)
+ LIBS = -lm -lws2_32
+ endif
+```
+
+4. Add patch for linking `libws2_32.a` in Windows OS at `Makefile.in` at *`/ngspice/src/`* by modifying the line:
+```make
+ @WINGUI_TRUE@am__append_19 = -lpsapi -lShlwapi
+```
+To
+```make
+ @WINGUI_TRUE@am__append_19 = -lpsapi -lShlwapi -lws2_32
+```
+
+5. Add GHDL codemodel to the spinit.in file at *`/ngspice/src/`* as an addition to the section:
+```make
+ * The other codemodels
+```
+with the line:
+```make
+ @XSPICEINIT@ codemodel @pkglibdir@/ghdl.cm
+```
+and in `GNUmakefile.in` at *`/ngspice/src/xspice/icm`* by replacing the line:
+```make
+ CMDIRS = spice2poly digital analog xtradev xtraevt table
+```
+with
+```make
+ CMDIRS = spice2poly digital analog xtradev xtraevt table ghdl
+```
+
+6. Create a **`ghdl` folder** with two empty files named `modpath.lst` and `udnpath.lst` at the location *`/ngspice/src/xspice/icm/`*
diff --git a/README.md b/README.md
new file mode 100644
index 0000000..b9bbb59
--- /dev/null
+++ b/README.md
@@ -0,0 +1,15 @@
+NGHDL Packaging
+====
+
+It contains all the documentation for packaging NGHDL to be distributed with [eSim](https://github.com/fossee/esim).
+
+
+## Packaging NGHDL with eSim?
+
+1. NGHDL is currently packaged for Ubuntu OS (Linux) and MS Windows OS.
+
+2. Refer the [documentation](Ngspice_Version_Change.md) for the changes to be done when the Ngspice is to be upgraded to a new verion. Note that these changes are common to both Ubuntu and Windows OS.
+
+3. Refer the [documentation](Ubuntu/README.md) to package eSim for Ubuntu OS.
+
+4. Refer the [documentation](Windows/README.md) to package eSim for Windows OS. \ No newline at end of file
diff --git a/Ubuntu/README.md b/Ubuntu/README.md
new file mode 100644
index 0000000..cbc0adb
--- /dev/null
+++ b/Ubuntu/README.md
@@ -0,0 +1,25 @@
+NGHDL Installer (Ubuntu OS)
+====
+
+It contains the documentation to package NGHDL for Ubuntu OS.
+
+> Note: If planning to freeze the NGHDL source code for a target platform (Ubuntu OS), then refer this [documentation](executable.md). Remember to update the installer script to work with this executable!
+
+## How to package NGHDL for Ubuntu OS?
+
+1. Take the `master` branch containing the source code. Rename the folder to `nghdl`.
+
+2. Add GHDL source code `ghdl-<version>.tar.xz` in the `nghdl` folder.
+
+3. Add the installer script `install-nghdl.sh` in the `nghdl` folder.
+
+4. Add the NGHDL executable (if available) in `nghdl/src` folder. Also, remove following files from this folder:
+ - `.git` folder
+ - all python files (Applicable only if eSim executable is used)
+ - GHDLside.md
+ - Workflow.md
+ - .gitignore
+
+2. Compress it to `.zip` format.
+
+3. Place this compressed file in `eSim-<version>` folder.
diff --git a/Ubuntu/executable.md b/Ubuntu/executable.md
new file mode 100644
index 0000000..9ac54a1
--- /dev/null
+++ b/Ubuntu/executable.md
@@ -0,0 +1,94 @@
+NGHDL Executable (Ubuntu OS)
+====
+
+> Note: It is not updated for the recently ported GUI to PyQt5 and Ubuntu 20.04 LTS. Currently, packaging for Ubuntu OS is done directly with the source code and not the executable.
+
+It contains the documentation for making NGHDL executable using PyInstaller on Ubuntu 16.04 and above.
+
+
+## Freeze NGHDL source code:
+
+1. Download `virtualenv` package and create virtual environment as:
+
+ $ pip install virtualenv
+ $ virtualenv -p /usr/bin/python3 nghdl
+
+ OR
+
+ $ sudo apt install -y python3-venv
+ $ python3 -m venv nghdl
+
+2. Activate the virtual environment as:
+
+ $ source nghdl/bin/activate
+
+3. Install all Python dependencies for NGHDL within the virtual environment as:
+
+ $ pip install wheel
+ $ pip install pyinstaller
+ $ pip install --upgrade 'setuptools<45.0.0'
+ $ sudo apt install build-essential python3-dev libqt4-dev qt4-dev-tools
+ $ mkdir nghdl/build
+ $ cd nghdl/build/
+ $ wget http://sourceforge.net/projects/pyqt/files/PyQt4/PyQt-4.12.3/PyQt4_gpl_x11-4.12.3.tar.gz
+ $ wget https://www.riverbankcomputing.com/static/Downloads/sip/4.19.21/sip-4.19.21.tar.gz
+ $ tar xzvf sip-4.19.21.tar.gz
+ $ tar xvzf PyQt4_gpl_x11-4.12.3.tar.gz
+ $ cd sip-4.19.21/
+ $ python configure.py --sip-module PyQt4.sip
+ $ make
+ $ make install
+ $ cd ../PyQt4_gpl_x11-4.12.3/
+ $ python configure.py
+ $ make
+ $ make install
+
+4. Now uninstall PyQt4, sip, matplotlib, numpy, dateutil and cycler globally (if any).
+
+5. Test whether only NGHDL dependencies are available or not:
+
+ $ pip freeze
+
+> Note : Following dependencies should be available -
+> - PyQt4
+> - sip
+
+6. Create spec file as:
+
+ $ pyi-makespec --onefile -n nghdl <path_to_nghdl>/src/ngspice_ghdl.py
+
+7. Add `PyQt4.sip` as hiddenimports in the generated spec file.
+
+8. Create onefile executable using pyinstaller as:
+
+ $ pyinstaller -F --clean nghdl.spec
+
+9. Verify whether all NGHDL `src` files (`*.py`) have been included in `Analysis-00.toc` file under the build folder generated by PyInstaller.
+
+
+## Fully-Static Bundled Version of NGHDL:
+
+1. To create a [fully-static bundled version](https://github.com/pyinstaller/pyinstaller/wiki/FAQ#GNULinux) of NGHDL (through PyInstaller), use a tool like [StaticX](https://github.com/JonathonReinhart/staticx/).
+
+2. To create fully-static NGHDL :
+
+ - Activate the virtual environment as:
+
+ $ source nghdl/bin/activate
+
+ - Install StaticX as:
+
+ $ pip install staticx
+ $ pip install patchelf-wrapper
+
+ - Create static NGHDL as:
+
+ $ staticx /path/to/executable/nghdl /path/to/output/executable/nghdl
+
+3. To verify if all dynamic libraries are removed :
+
+ - Type following command in a terminal :
+
+ $ ldd path/to/output/executable/nghdl
+
+ - Output of above command should be similar to ` not a dynamic executable`
diff --git a/Ubuntu/ghdl-0.37.tar.xz b/Ubuntu/ghdl-0.37.tar.xz
new file mode 100644
index 0000000..2442cb3
--- /dev/null
+++ b/Ubuntu/ghdl-0.37.tar.xz
Binary files differ
diff --git a/Ubuntu/install-nghdl.sh b/Ubuntu/install-nghdl.sh
new file mode 100755
index 0000000..fcb3eab
--- /dev/null
+++ b/Ubuntu/install-nghdl.sh
@@ -0,0 +1,242 @@
+#!/bin/bash
+#===============================================================================
+# FILE: install-nghdl.sh
+#
+# USAGE: ./install-nghdl.sh --install
+# OR
+# ./install-nghdl.sh --uninstall
+#
+# DESCRIPTION: Installation script for Ngspice and GHDL simulators (NGHDL)
+#
+# OPTIONS: ---
+# REQUIREMENTS: ---
+# BUGS: ---
+# NOTES: ---
+# AUTHOR: Fahim Khan, Rahul Paknikar
+# ORGANIZATION: eSim, FOSSEE group at IIT Bombay
+# CREATED: Tuesday 02 December 2014 17:01
+# REVISION: Sunday 02 August 2020 01:35
+#===============================================================================
+
+set -e # Set exit option immediately on error
+set -E # inherit ERR trap by shell functions
+
+error_exit() {
+ echo -e "\n\nError! Kindly resolve above error(s) and try again."
+ echo -e "\nAborting Installation...\n"
+}
+
+# Trap on function error_exit before exiting on error
+trap error_exit ERR
+
+
+ngspice="ngspice-nghdl"
+ghdl="ghdl-0.37"
+config_dir="$HOME/.nghdl"
+config_file="config.ini"
+src_dir=`pwd`
+
+# Will be used to take backup of any file
+sysdate="$(date)"
+timestamp=`echo $sysdate|awk '{print $3"_"$2"_"$6"_"$4 }'`
+
+
+# All functions goes here
+function installDependency
+{
+
+ echo "Installing dependencies for $ghdl LLVM................"
+
+ echo "Installing Make..........................................."
+ sudo apt install -y make
+
+ echo "Installing GNAT..........................................."
+ sudo apt install -y gnat
+
+ echo "Installing LLVM-8........................................."
+ sudo apt install -y llvm-8
+
+ echo "Installing Clang.........................................."
+ sudo apt-get install -y clang
+
+ echo "Installing Zlib1g-dev....................................."
+ sudo apt install -y zlib1g-dev
+
+ # Specific dependency for canberra-gtk modules
+ echo "Installing Gtk Canberra modules..........................."
+ sudo apt install -y libcanberra-gtk-module libcanberra-gtk3-module
+
+ # Specific dependency for nvidia graphic cards
+ echo "Installing graphics dependency for ngspice souce build"
+ echo "Installing libxaw7........................................"
+ sudo apt install -y libxaw7
+
+ echo "Installing libxaw7-dev...................................."
+ sudo apt install -y libxaw7-dev
+
+
+ echo "Installing $ghdl LLVM................................."
+ tar -xJf $ghdl.tar.xz
+ echo "$ghdl successfully extracted"
+ echo "Changing directory to $ghdl installation"
+ cd $ghdl/
+ echo "Configuring $ghdl build as per requirements"
+ chmod +x configure
+ # Other configure flags can be found at - https://github.com/ghdl/ghdl/blob/master/configure
+ sudo ./configure --with-llvm-config=/usr/bin/llvm-config-8
+ echo "Building the install file for $ghdl LLVM"
+ sudo make
+ sudo make install
+
+ set +e # Temporary disable exit on error
+ trap "" ERR # Do not trap on error of any command
+
+ echo "Removing unused part of $ghdl LLVM"
+ sudo rm -rf ../$ghdl
+
+ set -e # Re-enable exit on error
+ trap error_exit ERR
+
+ echo "GHDL installed successfully"
+
+}
+
+
+function installNgspice
+{
+
+ echo "Installing Ngspice........................................"
+
+ # Extracting Ngspice to Home Directory
+ cd $src_dir
+ tar -xJf $ngspice.tar.xz -C $HOME
+
+ echo "Ngspice extracted sucessfully to $HOME"
+ # Change to ngspice-nghdl directory
+ cd $HOME/$ngspice
+ # Make local install directory
+ mkdir -p install_dir
+ # Make release directory for build
+ mkdir -p release
+ # Change to release directory
+ cd release
+ echo "Configuring Ngspice........."
+ sleep 2
+
+ chmod +x ../configure
+ ../configure --enable-xspice --disable-debug --prefix=$HOME/$ngspice/install_dir/ --exec-prefix=$HOME/$ngspice/install_dir/
+
+ # Adding patch to Ngspice base code
+ cp $src_dir/src/outitf.c $HOME/$ngspice/src/frontend
+
+ make -j$(nproc)
+ make install
+
+ # Make it executable
+ sudo chmod 755 $HOME/$ngspice/install_dir/bin/ngspice
+
+ set +e # Temporary disable exit on error
+ trap "" ERR # Do not trap on error of any command
+
+ echo "Removing previously installed Ngspice (if any)"
+ sudo apt-get purge -y ngspice
+
+ echo "Ngspice installed sucessfully"
+ echo "Adding softlink for the installed Ngspice"
+
+ # Add symlink to the path
+ sudo rm /usr/bin/ngspice
+
+ set -e # Re-enable exit on error
+ trap error_exit ERR
+
+ sudo ln -sf $HOME/$ngspice/install_dir/bin/ngspice /usr/bin/ngspice
+ echo "Added softlink for Ngspice..."
+
+}
+
+
+function createConfigFile
+{
+
+ # Creating config.ini file and adding configuration information
+ # Check if config file is present
+ if [ -d $config_dir ];then
+ rm $config_dir/$config_file && touch $config_dir/$config_file
+ else
+ mkdir $config_dir && touch $config_dir/$config_file
+ fi
+
+ echo "[NGSPICE]" >> $config_dir/$config_file
+ echo "NGSPICE_HOME = $HOME/$ngspice" >> $config_dir/$config_file
+ echo "DIGITAL_MODEL = %(NGSPICE_HOME)s/src/xspice/icm/ghdl" >> $config_dir/$config_file
+ echo "RELEASE = %(NGSPICE_HOME)s/release" >> $config_dir/$config_file
+ echo "[SRC]" >> $config_dir/$config_file
+ echo "SRC_HOME = $src_dir" >> $config_dir/$config_file
+ echo "LICENSE = %(SRC_HOME)s/LICENSE" >> $config_dir/$config_file
+
+}
+
+
+function createSoftLink
+{
+ # Make it executable
+ sudo chmod 755 $src_dir/src/ngspice_ghdl.py
+
+ # Creating softlink
+ cd /usr/local/bin
+ if [[ -L nghdl ]];then
+ echo "Symlink was already present"
+ sudo unlink nghdl
+ fi
+
+ sudo ln -sf $src_dir/src/ngspice_ghdl.py nghdl
+ echo "Added softlink for NGHDL..."
+
+ cd $pwd
+
+}
+
+
+#####################################################################
+# Script start from here #
+#####################################################################
+
+### Checking if file is passsed as argument to script
+
+if [ "$#" -eq 1 ];then
+ option=$1
+else
+ echo "USAGE : "
+ echo "./install-nghdl.sh --install"
+ exit 1;
+fi
+
+## Checking flags
+if [ $option == "--install" ];then
+
+ #Calling functions
+ installDependency
+ if [ $? -ne 0 ];then
+ echo -e "\n\n\nERROR: Unable to install required packages. Please check your internet connection.\n\n"
+ exit 0
+ fi
+ installNgspice
+ createConfigFile
+ createSoftLink
+
+elif [ $option == "--uninstall" ];then
+ sudo rm -rf $HOME/ngspice-nghdl $HOME/.nghdl /usr/share/kicad/library/eSim_Nghdl.lib /usr/local/bin/nghdl /usr/bin/ngspice
+ echo "Removing libxaw7-dev..............."
+ sudo apt purge -y libxaw7-dev
+ echo "Removing GHDL......................"
+ sudo rm -rf /usr/local/bin/ghdl /usr/local/bin/ghdl1-llvm /usr/local/lib/ghdl /usr/local/lib/libghdlvpi.so /usr/local/include/vpi_user.h
+ echo "Removing LLVM......................"
+ sudo apt-get purge -y llvm-8
+ echo "Removing GNAT......................"
+ sudo apt purge -y gnat
+else
+ echo "Please select the proper operation."
+ echo "--install"
+ echo "--uninstall"
+fi
diff --git a/Debian/nghdl.spec b/Ubuntu/nghdl.spec
index 61f3fa8..61f3fa8 100644
--- a/Debian/nghdl.spec
+++ b/Ubuntu/nghdl.spec
diff --git a/Windows/README.md b/Windows/README.md
new file mode 100644
index 0000000..6f5aae9
--- /dev/null
+++ b/Windows/README.md
@@ -0,0 +1,106 @@
+NGHDL Installer (Windows OS)
+====
+
+
+It contains all the documenation for making NGHDL executable (using PyInstaller) and packging for eSim Installation Script on Windows 7 and above.
+
+
+## NGHDL Executable:
+
+1. Download and install "Python-3.5.2", "Git For Windows". Use "Git Bash" for all following shell commands.
+
+ Reference - https://gitforwindows.org/
+
+2. Add alias to python.exe in Git shell:
+
+ $ alias python='winpty python.exe' #Need to be done for each new shell created
+
+3. Download `virtualenv` package as:
+
+ $ pip install virtualenv
+
+4. Create a virtual environment as:
+
+ $ python -m virtualenv nghdl
+
+5. Activate the virtual environment as:
+
+ $ source nghdl/Scripts/activate
+
+6. Install all Python dependencies for NGHDL within the virtual environment as:
+
+ - Install PyInstaller, tornado, SetupTools through pip :
+
+ $ pip install pyinstaller
+ $ pip install --upgrade 'setuptools<45.0.0'
+
+ - Install PyQt4 through pip (Reference - https://stackoverflow.com/questions/22640640/how-to-install-pyqt4-on-windows-using-pip) :
+
+ $ pip install --upgrade 'sip<5.0.0'
+ $ pip install <wheel_package_of_PyQt4>
+
+ Download PyQt4 Wheel from - [https://www.lfd.uci.edu/~gohlke/pythonlibs/#pyqt4]
+ Where cp37 represents the Python version i.e. 3.7.x and so on
+
+ > Note :
+ - If there are any issues regarding loading of DLL files, refer : https://stackoverflow.com/questions/2738879/cannot-import-pyqt4-qtgui
+ - If above step works, then goto step 7.
+
+7. Test whether only NGHDL dependencies are available or not:
+
+ $ pip freeze
+
+> Note : Following dependencies should be available -
+> - PyQt4
+> - sip
+> - altgraph
+> - future
+> - pefile
+> - pyinstaller
+> - pywin32-ctypes
+
+
+8. Create spec file as:
+
+ $ pyi-makespec --onefile -n nghdl <path_to_nghdl>/src/ngspice_ghdl.py
+
+9. Create onefile executable using pyinstaller as:
+
+ $ pyinstaller -F --clean nghdl.spec
+
+10. Verify whether all NGHDL `src` files (`*.py`) have been included in `Analysis-00.toc` file under the build folder generated by PyInstaller.
+11. nghdl.exe is generated at the dist folder.
+
+
+
+## How to package NGHDL with eSim ?
+
+1. Place the nghdl.exe generated from the above process at the location /nghdl/src/
+
+2. Delete all python files (files ending in .py) at /nghdl/src/
+
+3. Remove the following files at /nghdl/
+ - .gitignore
+ - GHDLside.md
+ - Workflow.md
+
+4. Place **nghdl** folder containing `src folder`, `Example folder` & `LICENSE` under folder named eSim/
+
+5. Final directory structure should be:
+- eSim/nghdl/Example
+- eSim/nghdl/src
+- eSim/nghdl/LICENSE
+
+6. Compress the `eSim` folder from step 4 in 7z format (Make sure that there is folder named `eSim` inside this compressed file) and name it as `nghdl-src.7z`.\
+(7z compression tool can be downloaded from - https://www.7-zip.org/download.html )
+
+7. ALong with `nghdl-src.7z` from step 5, place the following 7z files at the installer folder for eSim.
+(these can be obtained under *sources/* folder in the repository )
+- ghdl.7z
+- MSYS.7z
+- ngspice-nghdl.7z
+- mingw64.7z
+
+8. Place the script `installnghdl.nsi` at the eSim installer location.
+
+9. Follow the rest of the instructions for packging eSim [https://github.com/FOSSEE/eSim/tree/installers/Windows] and compile the NSI script (`esim-setup-script.nsi` file). Now only use the generated installer for distribution.
diff --git a/readme.md b/readme.md
deleted file mode 100644
index b86b7c3..0000000
--- a/readme.md
+++ /dev/null
@@ -1,15 +0,0 @@
-NGHDL Installers
-====
-
-It contains all the documenation for making installations on various platforms.
-
-
-## How to package NGHDL with eSim?
-1. Add GHDL executable and the corresponding installer for the target OS in the `nghdl` folder.
-
-> Note : Instructions on how to generate NGHDL executable and distribute it along with GHDL are
-> provided under respective target OS directory.
-
-2. Rename `nghdl` folder as `nghdl-master` and compress it to `.zip` format.
-
-3. Place this compressed file in `eSim-<version>` folder.