Merge pull request #46 from rahulp13/installers

revert to packaging with src, update readme

3 files changed, 149 insertions, 99 deletions

diff --git a/Debian/Ubuntu 14.04/install-nghdl.sh b/Debian/Ubuntu 14.04/install-nghdl.sh
index 5b724c4..9400da6 100755
--- a/Debian/Ubuntu 14.04/install-nghdl.sh
+++ b/Debian/Ubuntu 14.04/install-nghdl.sh
@@ -6,15 +6,15 @@
 #                 or
 #                ./install-nghdl.sh --uninstall
 # 
-#   DESCRIPTION: It is installation script for ngspice and ghdl work (nghdl). 
-# 
+#   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: Friday 14 February 2020 16:30
+#       CREATED: Tuesday 31 March 2020 16:30
 #      REVISION:  ---
 #===============================================================================
 
@@ -24,12 +24,12 @@ config_dir="$HOME/.nghdl"
 config_file="config.ini"
 src_dir=`pwd`
 
-#Will be used to take backup of any file
+# Will be used to take backup of any file
 sysdate="$(date)"
 timestamp=`echo $sysdate|awk '{print $3"_"$2"_"$6"_"$4 }'`
 
 
-#All functions goes here
+# All functions goes here
 function installDependency
 {
 
@@ -78,47 +78,47 @@ function installDependency
     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......"
+            echo "ghdl-0.36 successfully extracted"
+            echo "Changing directory to ghdl-0.36 installation"
             cd ghdl-0.36/
-            #Copy compiled ghdl to system path
+            # Copy compiled ghdl to system path
             sudo cp bin/* /usr/local/bin/
-            #Make it executable
+            # 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..."
+                echo "Exiting installation"
                 exit 1
             fi
 
             sudo cp include/* /usr/local/include/
-            #Make it accessible
+            # 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..."
+                echo "Exiting installation"
                 exit 1
             fi
 
             sudo cp -r lib/* /usr/local/lib/
-            #Make it accessible
+            # 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..."
+                echo "Exiting installation"
                 exit 1
             fi
 
             echo "Removing unused part of ghdl-0.36 LLVM..."
     		rm -rf ../ghdl-0.36
-            echo "GHDL installed successfully......................."
+            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 "GHDL already exists......................................."
         echo "Leaving ghdl-0.36 LLVM installation"
     fi
     
@@ -129,39 +129,39 @@ function installNgspice
 {
 
     echo "Installing Ngspice........................................"
-    #Checking if ngspice-nghdl directory is already present in Home directory
+    # 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..."
+        echo "$ngspice directory already exists at $HOME................"
+        echo "Leaving Ngspice installation"
     else
-        #Extracting Ngspice to Home Directory
+        # 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
+            # Change to ngspice-nghdl directory
             cd $HOME/$ngspice
-            #Make local install directory
+            # Make local install directory
             mkdir -p install_dir
-            #Make release directory for build
+            # Make release directory for build
             mkdir -p release
-            #Change to release directory
+            # Change to release directory
             cd release
-            echo "Configuring Ngspice..."
+            echo "Configuring Ngspice"
             sleep 2
             ../configure --enable-xspice --disable-debug  --prefix=$HOME/$ngspice/install_dir/ --exec-prefix=$HOME/$ngspice/install_dir/
             
-            #dirty fix for adding patch to ngspice base code
+            # 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)..."
+                echo "Removing previously installed Ngspice (if any)"
                 sudo apt-get purge -y ngspice
 
-                echo "Ngspice installed sucessfully................."
-                echo "Adding softlink for the installed Ngspice....."
+                echo "Ngspice installed sucessfully"
+                echo "Adding softlink for the installed Ngspice"
 
                 #Make it executable
     			sudo chmod 755 $HOME/$ngspice/install_dir/bin/ngspice
@@ -169,11 +169,11 @@ function installNgspice
                 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..."
+                    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...................."
+                echo "Added softlink for Ngspice................................"
             else 
                 echo "There was some error while installing Ngspice"
             fi
@@ -189,8 +189,8 @@ function installNgspice
 function createConfigFile
 {
     
-    #Creating config.ini file and adding configuration information
-    #Check if config file is present
+    # 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
@@ -210,25 +210,25 @@ function createConfigFile
 
 function createSoftLink
 {
-    #Make it executable
-    sudo chmod 755 $src_dir/src/nghdl
+    # Make it executable
+    sudo chmod 755 $src_dir/src/ngspice_ghdl.py
 
-    ## Creating softlink 
+    # Creating softlink 
     cd /usr/local/bin
     if [[ -L nghdl ]];then
         echo "Symlink was already present"
         sudo unlink nghdl
-        sudo ln -sf $src_dir/src/nghdl nghdl
+        sudo ln -sf $src_dir/src/ngspice_ghdl.py nghdl
     else
         echo "Creating symlink"
-        sudo ln -sf $src_dir/src/nghdl nghdl
+        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..."
+            echo "Remove earlier installations at /usr/local/bin/nghdl and try again"
             exit 1
         fi
     fi
-    echo "Added softlink for NGHDL..............................."
+    echo "Added softlink for NGHDL.................................."
 
     cd $pwd
 
@@ -239,7 +239,7 @@ function createSoftLink
 #       Script start from here                                     #
 #####################################################################
 
-###Checking if file is passsed as argument to script
+### Checking if file is passsed as argument to script
 
 if [ "$#" -eq 1 ];then
     option=$1
@@ -249,10 +249,10 @@ else
     exit 1;
 fi
 
-##Checking flags
+## Checking flags
 if [ $option == "--install" ];then
     
-    #Calling functions
+    # Calling functions
     installDependency
     if [ $? -ne 0 ];then
         echo -e "\n\n\nERROR: Unable to install required packages. Please check your internet connection.\n\n"
diff --git a/Debian/Ubuntu 16.04+/install-nghdl.sh b/Debian/Ubuntu 16.04+/install-nghdl.sh
index a169b2f..4a38418 100755
--- a/Debian/Ubuntu 16.04+/install-nghdl.sh
+++ b/Debian/Ubuntu 16.04+/install-nghdl.sh
@@ -6,15 +6,15 @@
 #                 or
 #                ./install-nghdl.sh --uninstall
 # 
-#   DESCRIPTION: It is installation script for ngspice and ghdl work (nghdl). 
-# 
+#   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: Friday 14 February 2020 16:30
+#       CREATED: Tuesday 31 March 2020 16:30
 #      REVISION:  ---
 #===============================================================================
 
@@ -24,12 +24,12 @@ config_dir="$HOME/.nghdl"
 config_file="config.ini"
 src_dir=`pwd`
 
-#Will be used to take backup of any file
+# Will be used to take backup of any file
 sysdate="$(date)"
 timestamp=`echo $sysdate|awk '{print $3"_"$2"_"$6"_"$4 }'`
 
 
-#All functions goes here
+# All functions goes here
 function installDependency
 {
 
@@ -56,7 +56,7 @@ function installDependency
         exit 1
     fi    
 
-    echo "Installing Clang................................."
+    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."
@@ -100,25 +100,25 @@ function installDependency
     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..."
+            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
+            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..."
+            echo "Building the install file for ghdl-0.36 LLVM"
             sudo make -j$(nproc)
-            echo "Installing ghdl-0.36 LLVM..."
             sudo make install
-            echo "Removing unused part of ghdl-0.36 LLVM....."
+            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 "GHDL already exists......................................."
         echo "Leaving ghdl-0.36 LLVM installation"
     fi
     
@@ -129,51 +129,51 @@ function installNgspice
 {
 
     echo "Installing Ngspice........................................"
-    #Checking if ngspice-nghdl directory is already present in Home directory
+    # 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..."
+        echo "$ngspice directory already exists at $HOME................"
+        echo "Leaving Ngspice installation"
     else
-        #Extracting Ngspice to Home Directory
+        # 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
+            # Change to ngspice-nghdl directory
             cd $HOME/$ngspice
-            #Make local install directory
+            # Make local install directory
             mkdir -p install_dir
-            #Make release directory for build
+            # Make release directory for build
             mkdir -p release
-            #Change to release directory
+            # Change to release directory
             cd release
-            echo "Configuring Ngspice..."
+            echo "Configuring Ngspice"
             sleep 2
             ../configure --enable-xspice --disable-debug  --prefix=$HOME/$ngspice/install_dir/ --exec-prefix=$HOME/$ngspice/install_dir/
             
-            #dirty fix for adding patch to ngspice base code
+            # 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)..."
+                echo "Removing previously installed Ngspice (if any)"
                 sudo apt-get purge -y ngspice
 
-                echo "Ngspice installed sucessfully................."
-                echo "Adding softlink for the installed Ngspice....."
+                echo "Ngspice installed sucessfully"
+                echo "Adding softlink for the installed Ngspice"
 
-                #Make it executable
+                # 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..."
+                    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...................."
+                echo "Added softlink for Ngspice................................"
             else 
                 echo "There was some error while installing Ngspice"
             fi
@@ -189,8 +189,8 @@ function installNgspice
 function createConfigFile
 {
     
-    #Creating config.ini file and adding configuration information
-    #Check if config file is present
+    # 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
@@ -210,25 +210,25 @@ function createConfigFile
 
 function createSoftLink
 {
-    #Make it executable
-    sudo chmod 755 $src_dir/src/nghdl
+    # Make it executable
+    sudo chmod 755 $src_dir/src/ngspice_ghdl.py
 
-    ## Creating softlink 
+    # Creating softlink
     cd /usr/local/bin
     if [[ -L nghdl ]];then
         echo "Symlink was already present"
         sudo unlink nghdl
-        sudo ln -sf $src_dir/src/nghdl nghdl
+        sudo ln -sf $src_dir/src/ngspice_ghdl.py nghdl
     else
         echo "Creating symlink"
-        sudo ln -sf $src_dir/src/nghdl nghdl
+        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..."
+            echo "Remove earlier installations at /usr/local/bin/nghdl and try again"
             exit 1
         fi
     fi
-    echo "Added softlink for NGHDL..............................."
+    echo "Added softlink for NGHDL.................................."
 
     cd $pwd
 
@@ -239,7 +239,7 @@ function createSoftLink
 #       Script start from here                                     #
 #####################################################################
 
-###Checking if file is passsed as argument to script
+### Checking if file is passsed as argument to script
 
 if [ "$#" -eq 1 ];then
     option=$1
@@ -249,7 +249,7 @@ else
     exit 1;
 fi
 
-##Checking flags
+## Checking flags
 if [ $option == "--install" ];then
     
     #Calling functions
diff --git a/Debian/readme.md b/Debian/readme.md
index 2da9deb..04e3647 100644
--- a/Debian/readme.md
+++ b/Debian/readme.md
@@ -1,4 +1,4 @@
-NGHDL Installer (Ubuntu)
+NGHDL Installer (Ubuntu OS)
 ====
 
 
@@ -8,20 +8,23 @@ Separate installers are required to resolve dependencies only for GHDL and are m
 
 ## NGDHL EXECUTABLE:
 
-1. Download `virtualenv` package as:
+1. Download `virtualenv` package and create virtual environment as:
 
 	    $ pip install virtualenv
+	    $ virtualenv -p /usr/bin/python3 nghdl
 
-2. Create a virtual environment as:
-
-		$ virtualenv -p /usr/bin/python3 nghdl
+			OR
+		
+	    $ sudo apt install -y python3-venv
+	    $ python3 -m venv nghdl
 
-3. Activate the virtual environment as:
+2. Activate the virtual environment as:
 	
 		$ source nghdl/bin/activate
 
-4. Install all Python dependencies for eSim within the virtual environment as:
+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
@@ -40,9 +43,9 @@ Separate installers are required to resolve dependencies only for GHDL and are m
 		$ make
 		$ make install
 
-5. Now uninstall PyQt4, sip, matplotlib, numpy, dateutil and cycler globally (if any).
+4. Now uninstall PyQt4, sip, matplotlib, numpy, dateutil and cycler globally (if any).
 
-6. Test whether only NGHDL dependencies are available or not:
+5. Test whether only NGHDL dependencies are available or not:
 
 		$ pip freeze
 
@@ -50,43 +53,90 @@ Separate installers are required to resolve dependencies only for GHDL and are m
 >	- PyQt4
 > 	- sip
 
-7. Create spec file as:
+6. Create spec file as:
 
 		$ pyi-makespec --onefile -n nghdl <path_to_nghdl>/src/ngspice_ghdl.py
 
-8. Add `PyQt4.sip` as hiddenimports in the generated spec file.
+7. Add `PyQt4.sip` as hiddenimports in the generated spec file.
 
-9. Create onefile executable using pyinstaller as:
+8. 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.
+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