From 8bda5e79eee55752e2d95dddc34bb10122c485f6 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Thu, 16 Jul 2020 22:47:30 +0530 Subject: script to be included in esim-setup-script.nsi --- installnghdl.nsi | 190 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 190 insertions(+) create mode 100644 installnghdl.nsi diff --git a/installnghdl.nsi b/installnghdl.nsi new file mode 100644 index 0000000..0ab7da4 --- /dev/null +++ b/installnghdl.nsi @@ -0,0 +1,190 @@ +!include "CPUFeatures.nsh" +!include "zipdll.nsh" + +;----------------------------------------------------------------------------------------- +; String replacement function +!define StrRep "!insertmacro StrRep" +!macro StrRep output string old new + Push `${string}` + Push `${old}` + Push `${new}` + !ifdef __UNINSTALL__ + Call un.StrRep + !else + Call StrRep + !endif + Pop ${output} +!macroend + +!macro Func_StrRep un + Function ${un}StrRep + Exch $R2 ;new + Exch 1 + Exch $R1 ;old + Exch 2 + Exch $R0 ;string + Push $R3 + Push $R4 + Push $R5 + Push $R6 + Push $R7 + Push $R8 + Push $R9 + + StrCpy $R3 0 + StrLen $R4 $R1 + StrLen $R6 $R0 + StrLen $R9 $R2 + loop: + StrCpy $R5 $R0 $R4 $R3 + StrCmp $R5 $R1 found + StrCmp $R3 $R6 done + IntOp $R3 $R3 + 1 ;move offset by 1 to check the next character + Goto loop + found: + StrCpy $R5 $R0 $R3 + IntOp $R8 $R3 + $R4 + StrCpy $R7 $R0 "" $R8 + StrCpy $R0 $R5$R2$R7 + StrLen $R6 $R0 + IntOp $R3 $R3 + $R9 ;move offset by length of the replacement string + Goto loop + done: + + Pop $R9 + Pop $R8 + Pop $R7 + Pop $R6 + Pop $R5 + Pop $R4 + Pop $R3 + Push $R0 + Push $R1 + Pop $R0 + Pop $R1 + Pop $R0 + Pop $R2 + Exch $R1 + FunctionEnd +!macroend +!insertmacro Func_StrRep "" +!insertmacro Func_StrRep "un." +;----------------------------------------------------------------------------------------- + +;----------------------------------------------------------------------------------------- +; NGHDL installation macro +Section "nghdl-loadsource" + SetOutPath $EXEDIR + + File "ghdl.zip" + File "mingw.7z" + File "MSYS.zip" + File "nghdl-src.zip" + File "ngspice-nghdl.zip" +SectionEnd + +Section "nghdl-src" + SetOutPath $INSTDIR + ZipDLL::extractall "$EXEDIR\nghdl-src.zip" "$INSTDIR\" + EnVar::SetHKLM + DetailPrint "EnVar::SetHKLM" + EnVar::AddValue "Path" "$INSTDIR\eSim\nghdl\src" + Pop $0 + DetailPrint "EnVar::AddValue returned=|$0|" + Delete "$EXEDIR\nghdl-src.zip" +SectionEnd + +Section "nghdl-mingw" + SetOutPath $INSTDIR + Nsis7z::ExtractWithDetails "$EXEDIR\mingw.7z" "Extracting MinGW %s..." + EnVar::SetHKLM + EnVar::AddValue "Path" "$INSTDIR\mingw64\bin" + Pop $0 + DetailPrint "EnVar::AddValue returned=|$0|" + Delete "$EXEDIR\mingw.7z" +SectionEnd + +Section "nghdl-msys" + SetOutPath $INSTDIR\mingw64 + ZipDLL::extractall "$EXEDIR\MSYS.zip" "$INSTDIR\mingw64\" + EnVar::SetHKLM + EnVar::AddValue "Path" "$INSTDIR\mingw64\msys\bin" + Pop $0 + DetailPrint "EnVar::AddValue returned=|$0|" + Delete "$EXEDIR\MSYS.zip" +SectionEnd + +Section "nghdl-GHDL" + SetOutPath $INSTDIR\mingw64 + ZipDLL::extractall "$EXEDIR\ghdl.zip" "$INSTDIR\mingw64\" + EnVar::SetHKLM + EnVar::AddValue "Path" "$INSTDIR\mingw64\GHDL\bin" + Pop $0 + DetailPrint "EnVar::AddValue returned=|$0|" + Delete "$EXEDIR\ghdl.zip" +SectionEnd + +Section "envar-refresh" + ReadEnvStr $R0 "PATH" + StrCpy $R0 "$R0;$INSTDIR\eSim\nghdl\src;$INSTDIR\mingw64\bin;$INSTDIR\mingw64\msys\bin;$INSTDIR\mingw64\GHDL\bin;" + System::Call 'Kernel32::SetEnvironmentVariable(t, t) i("PATH", R0).r0' +SectionEnd + + +Section "nghdl-installNgspice" + SetOutPath $INSTDIR + ZipDLL::extractall "$EXEDIR\ngspice-nghdl.zip" "$INSTDIR\" + + CopyFiles $INSTDIR\eSim\nghdl\src\outitf.c $INSTDIR\ngspice-nghdl\src\frontend + + CopyFiles $INSTDIR\mingw64\x86_64-w64-mingw32\lib\libws2_32.a $INSTDIR\eSim\nghdl\src\ghdlserver + + SetOutPath $INSTDIR\ngspice-nghdl + CreateDirectory $INSTDIR\ngspice-nghdl\release + SetOutPath $INSTDIR\ngspice-nghdl\release + + Var /GLOBAL shellpath + Var /GLOBAL shellpath1 + Var /GLOBAL cpucores + + ${CPUFeatures.GetCount} $cpucores + + StrCpy $shellpath $INSTDIR + + ${StrRep} '$shellpath1' '$shellpath' '\' '/' + + FileOpen $0 "$INSTDIR\ngspice-nghdl\release\installngspice.sh" w + FileWrite $0 `../configure --with-wingui --enable-xspice --disable-debug --prefix=$shellpath1/ngspice-nghdl/install_dir --exec-prefix=$shellpath1/ngspice-nghdl/install_dir &&$\n` + FileWrite $0 `make -j$cpucores &&$\n` + FileWrite $0 `make install$\n` + FileClose $0 + + nsExec::ExecToLog "$INSTDIR\mingw64\msys\bin\bash.exe installngspice.sh" + Delete "$EXEDIR\ngspice-nghdl.zip" + Delete $INSTDIR\ngspice-nghdl\release\installngspice.sh + + SetOutPath $INSTDIR + + EnVar::SetHKLM + EnVar::AddValue "Path" "$INSTDIR\ngspice-nghdl\install_dir\bin" + Pop $0 + DetailPrint "EnVar::AddValue returned=|$0|" + +SectionEnd + +Section "nghdl-config.ini" + CreateDirectory $PROFILE\.nghdl + FileOpen $0 "$PROFILE\.nghdl\config.ini" w + FileWrite $0 `[NGSPICE]$\n` + FileWrite $0 `NGSPICE_HOME = $INSTDIR\ngspice-nghdl$\n` + FileWrite $0 `DIGITAL_MODEL = %(NGSPICE_HOME)s\src\xspice\icm\ghdl$\n` + FileWrite $0 `RELEASE = %(NGSPICE_HOME)s\release$\n` + FileWrite $0 `[SRC]$\n` + FileWrite $0 `SRC_HOME = $INSTDIR\eSim\nghdl$\n` + FileWrite $0 `LICENSE = %(SRC_HOME)s\LICENSE$\n` + FileWrite $0 `[COMPILER]$\n` + FileWrite $0 `MSYS_HOME = $INSTDIR\mingw64\msys\bin$\n` + FileClose $0 +SectionEnd + +;------------------------------------------------------------------------------------- -- cgit From d9c5366851f333d30335cef242b43b255162d510 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Thu, 16 Jul 2020 22:47:47 +0530 Subject: Delete installnghdl.nsi --- installnghdl.nsi | 190 ------------------------------------------------------- 1 file changed, 190 deletions(-) delete mode 100644 installnghdl.nsi diff --git a/installnghdl.nsi b/installnghdl.nsi deleted file mode 100644 index 0ab7da4..0000000 --- a/installnghdl.nsi +++ /dev/null @@ -1,190 +0,0 @@ -!include "CPUFeatures.nsh" -!include "zipdll.nsh" - -;----------------------------------------------------------------------------------------- -; String replacement function -!define StrRep "!insertmacro StrRep" -!macro StrRep output string old new - Push `${string}` - Push `${old}` - Push `${new}` - !ifdef __UNINSTALL__ - Call un.StrRep - !else - Call StrRep - !endif - Pop ${output} -!macroend - -!macro Func_StrRep un - Function ${un}StrRep - Exch $R2 ;new - Exch 1 - Exch $R1 ;old - Exch 2 - Exch $R0 ;string - Push $R3 - Push $R4 - Push $R5 - Push $R6 - Push $R7 - Push $R8 - Push $R9 - - StrCpy $R3 0 - StrLen $R4 $R1 - StrLen $R6 $R0 - StrLen $R9 $R2 - loop: - StrCpy $R5 $R0 $R4 $R3 - StrCmp $R5 $R1 found - StrCmp $R3 $R6 done - IntOp $R3 $R3 + 1 ;move offset by 1 to check the next character - Goto loop - found: - StrCpy $R5 $R0 $R3 - IntOp $R8 $R3 + $R4 - StrCpy $R7 $R0 "" $R8 - StrCpy $R0 $R5$R2$R7 - StrLen $R6 $R0 - IntOp $R3 $R3 + $R9 ;move offset by length of the replacement string - Goto loop - done: - - Pop $R9 - Pop $R8 - Pop $R7 - Pop $R6 - Pop $R5 - Pop $R4 - Pop $R3 - Push $R0 - Push $R1 - Pop $R0 - Pop $R1 - Pop $R0 - Pop $R2 - Exch $R1 - FunctionEnd -!macroend -!insertmacro Func_StrRep "" -!insertmacro Func_StrRep "un." -;----------------------------------------------------------------------------------------- - -;----------------------------------------------------------------------------------------- -; NGHDL installation macro -Section "nghdl-loadsource" - SetOutPath $EXEDIR - - File "ghdl.zip" - File "mingw.7z" - File "MSYS.zip" - File "nghdl-src.zip" - File "ngspice-nghdl.zip" -SectionEnd - -Section "nghdl-src" - SetOutPath $INSTDIR - ZipDLL::extractall "$EXEDIR\nghdl-src.zip" "$INSTDIR\" - EnVar::SetHKLM - DetailPrint "EnVar::SetHKLM" - EnVar::AddValue "Path" "$INSTDIR\eSim\nghdl\src" - Pop $0 - DetailPrint "EnVar::AddValue returned=|$0|" - Delete "$EXEDIR\nghdl-src.zip" -SectionEnd - -Section "nghdl-mingw" - SetOutPath $INSTDIR - Nsis7z::ExtractWithDetails "$EXEDIR\mingw.7z" "Extracting MinGW %s..." - EnVar::SetHKLM - EnVar::AddValue "Path" "$INSTDIR\mingw64\bin" - Pop $0 - DetailPrint "EnVar::AddValue returned=|$0|" - Delete "$EXEDIR\mingw.7z" -SectionEnd - -Section "nghdl-msys" - SetOutPath $INSTDIR\mingw64 - ZipDLL::extractall "$EXEDIR\MSYS.zip" "$INSTDIR\mingw64\" - EnVar::SetHKLM - EnVar::AddValue "Path" "$INSTDIR\mingw64\msys\bin" - Pop $0 - DetailPrint "EnVar::AddValue returned=|$0|" - Delete "$EXEDIR\MSYS.zip" -SectionEnd - -Section "nghdl-GHDL" - SetOutPath $INSTDIR\mingw64 - ZipDLL::extractall "$EXEDIR\ghdl.zip" "$INSTDIR\mingw64\" - EnVar::SetHKLM - EnVar::AddValue "Path" "$INSTDIR\mingw64\GHDL\bin" - Pop $0 - DetailPrint "EnVar::AddValue returned=|$0|" - Delete "$EXEDIR\ghdl.zip" -SectionEnd - -Section "envar-refresh" - ReadEnvStr $R0 "PATH" - StrCpy $R0 "$R0;$INSTDIR\eSim\nghdl\src;$INSTDIR\mingw64\bin;$INSTDIR\mingw64\msys\bin;$INSTDIR\mingw64\GHDL\bin;" - System::Call 'Kernel32::SetEnvironmentVariable(t, t) i("PATH", R0).r0' -SectionEnd - - -Section "nghdl-installNgspice" - SetOutPath $INSTDIR - ZipDLL::extractall "$EXEDIR\ngspice-nghdl.zip" "$INSTDIR\" - - CopyFiles $INSTDIR\eSim\nghdl\src\outitf.c $INSTDIR\ngspice-nghdl\src\frontend - - CopyFiles $INSTDIR\mingw64\x86_64-w64-mingw32\lib\libws2_32.a $INSTDIR\eSim\nghdl\src\ghdlserver - - SetOutPath $INSTDIR\ngspice-nghdl - CreateDirectory $INSTDIR\ngspice-nghdl\release - SetOutPath $INSTDIR\ngspice-nghdl\release - - Var /GLOBAL shellpath - Var /GLOBAL shellpath1 - Var /GLOBAL cpucores - - ${CPUFeatures.GetCount} $cpucores - - StrCpy $shellpath $INSTDIR - - ${StrRep} '$shellpath1' '$shellpath' '\' '/' - - FileOpen $0 "$INSTDIR\ngspice-nghdl\release\installngspice.sh" w - FileWrite $0 `../configure --with-wingui --enable-xspice --disable-debug --prefix=$shellpath1/ngspice-nghdl/install_dir --exec-prefix=$shellpath1/ngspice-nghdl/install_dir &&$\n` - FileWrite $0 `make -j$cpucores &&$\n` - FileWrite $0 `make install$\n` - FileClose $0 - - nsExec::ExecToLog "$INSTDIR\mingw64\msys\bin\bash.exe installngspice.sh" - Delete "$EXEDIR\ngspice-nghdl.zip" - Delete $INSTDIR\ngspice-nghdl\release\installngspice.sh - - SetOutPath $INSTDIR - - EnVar::SetHKLM - EnVar::AddValue "Path" "$INSTDIR\ngspice-nghdl\install_dir\bin" - Pop $0 - DetailPrint "EnVar::AddValue returned=|$0|" - -SectionEnd - -Section "nghdl-config.ini" - CreateDirectory $PROFILE\.nghdl - FileOpen $0 "$PROFILE\.nghdl\config.ini" w - FileWrite $0 `[NGSPICE]$\n` - FileWrite $0 `NGSPICE_HOME = $INSTDIR\ngspice-nghdl$\n` - FileWrite $0 `DIGITAL_MODEL = %(NGSPICE_HOME)s\src\xspice\icm\ghdl$\n` - FileWrite $0 `RELEASE = %(NGSPICE_HOME)s\release$\n` - FileWrite $0 `[SRC]$\n` - FileWrite $0 `SRC_HOME = $INSTDIR\eSim\nghdl$\n` - FileWrite $0 `LICENSE = %(SRC_HOME)s\LICENSE$\n` - FileWrite $0 `[COMPILER]$\n` - FileWrite $0 `MSYS_HOME = $INSTDIR\mingw64\msys\bin$\n` - FileClose $0 -SectionEnd - -;------------------------------------------------------------------------------------- -- cgit From 27dd0446334de2cd4d7cedde4db02ec9c289e65c Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Thu, 16 Jul 2020 22:48:15 +0530 Subject: Create Windows --- Windows | 1 + 1 file changed, 1 insertion(+) create mode 100644 Windows diff --git a/Windows b/Windows new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/Windows @@ -0,0 +1 @@ + -- cgit From d23b921cc098e1ebe625d5a7da146529a5bd6c4d Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Thu, 16 Jul 2020 22:48:34 +0530 Subject: Delete Windows --- Windows | 1 - 1 file changed, 1 deletion(-) delete mode 100644 Windows diff --git a/Windows b/Windows deleted file mode 100644 index 8b13789..0000000 --- a/Windows +++ /dev/null @@ -1 +0,0 @@ - -- cgit From 060b27b4427c604861d66da8fb565c1aff0585c7 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Thu, 16 Jul 2020 22:54:37 +0530 Subject: include in esim-setup-script.nsi --- Windows/installnghdl.nsi | 190 +++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 190 insertions(+) create mode 100644 Windows/installnghdl.nsi diff --git a/Windows/installnghdl.nsi b/Windows/installnghdl.nsi new file mode 100644 index 0000000..0ab7da4 --- /dev/null +++ b/Windows/installnghdl.nsi @@ -0,0 +1,190 @@ +!include "CPUFeatures.nsh" +!include "zipdll.nsh" + +;----------------------------------------------------------------------------------------- +; String replacement function +!define StrRep "!insertmacro StrRep" +!macro StrRep output string old new + Push `${string}` + Push `${old}` + Push `${new}` + !ifdef __UNINSTALL__ + Call un.StrRep + !else + Call StrRep + !endif + Pop ${output} +!macroend + +!macro Func_StrRep un + Function ${un}StrRep + Exch $R2 ;new + Exch 1 + Exch $R1 ;old + Exch 2 + Exch $R0 ;string + Push $R3 + Push $R4 + Push $R5 + Push $R6 + Push $R7 + Push $R8 + Push $R9 + + StrCpy $R3 0 + StrLen $R4 $R1 + StrLen $R6 $R0 + StrLen $R9 $R2 + loop: + StrCpy $R5 $R0 $R4 $R3 + StrCmp $R5 $R1 found + StrCmp $R3 $R6 done + IntOp $R3 $R3 + 1 ;move offset by 1 to check the next character + Goto loop + found: + StrCpy $R5 $R0 $R3 + IntOp $R8 $R3 + $R4 + StrCpy $R7 $R0 "" $R8 + StrCpy $R0 $R5$R2$R7 + StrLen $R6 $R0 + IntOp $R3 $R3 + $R9 ;move offset by length of the replacement string + Goto loop + done: + + Pop $R9 + Pop $R8 + Pop $R7 + Pop $R6 + Pop $R5 + Pop $R4 + Pop $R3 + Push $R0 + Push $R1 + Pop $R0 + Pop $R1 + Pop $R0 + Pop $R2 + Exch $R1 + FunctionEnd +!macroend +!insertmacro Func_StrRep "" +!insertmacro Func_StrRep "un." +;----------------------------------------------------------------------------------------- + +;----------------------------------------------------------------------------------------- +; NGHDL installation macro +Section "nghdl-loadsource" + SetOutPath $EXEDIR + + File "ghdl.zip" + File "mingw.7z" + File "MSYS.zip" + File "nghdl-src.zip" + File "ngspice-nghdl.zip" +SectionEnd + +Section "nghdl-src" + SetOutPath $INSTDIR + ZipDLL::extractall "$EXEDIR\nghdl-src.zip" "$INSTDIR\" + EnVar::SetHKLM + DetailPrint "EnVar::SetHKLM" + EnVar::AddValue "Path" "$INSTDIR\eSim\nghdl\src" + Pop $0 + DetailPrint "EnVar::AddValue returned=|$0|" + Delete "$EXEDIR\nghdl-src.zip" +SectionEnd + +Section "nghdl-mingw" + SetOutPath $INSTDIR + Nsis7z::ExtractWithDetails "$EXEDIR\mingw.7z" "Extracting MinGW %s..." + EnVar::SetHKLM + EnVar::AddValue "Path" "$INSTDIR\mingw64\bin" + Pop $0 + DetailPrint "EnVar::AddValue returned=|$0|" + Delete "$EXEDIR\mingw.7z" +SectionEnd + +Section "nghdl-msys" + SetOutPath $INSTDIR\mingw64 + ZipDLL::extractall "$EXEDIR\MSYS.zip" "$INSTDIR\mingw64\" + EnVar::SetHKLM + EnVar::AddValue "Path" "$INSTDIR\mingw64\msys\bin" + Pop $0 + DetailPrint "EnVar::AddValue returned=|$0|" + Delete "$EXEDIR\MSYS.zip" +SectionEnd + +Section "nghdl-GHDL" + SetOutPath $INSTDIR\mingw64 + ZipDLL::extractall "$EXEDIR\ghdl.zip" "$INSTDIR\mingw64\" + EnVar::SetHKLM + EnVar::AddValue "Path" "$INSTDIR\mingw64\GHDL\bin" + Pop $0 + DetailPrint "EnVar::AddValue returned=|$0|" + Delete "$EXEDIR\ghdl.zip" +SectionEnd + +Section "envar-refresh" + ReadEnvStr $R0 "PATH" + StrCpy $R0 "$R0;$INSTDIR\eSim\nghdl\src;$INSTDIR\mingw64\bin;$INSTDIR\mingw64\msys\bin;$INSTDIR\mingw64\GHDL\bin;" + System::Call 'Kernel32::SetEnvironmentVariable(t, t) i("PATH", R0).r0' +SectionEnd + + +Section "nghdl-installNgspice" + SetOutPath $INSTDIR + ZipDLL::extractall "$EXEDIR\ngspice-nghdl.zip" "$INSTDIR\" + + CopyFiles $INSTDIR\eSim\nghdl\src\outitf.c $INSTDIR\ngspice-nghdl\src\frontend + + CopyFiles $INSTDIR\mingw64\x86_64-w64-mingw32\lib\libws2_32.a $INSTDIR\eSim\nghdl\src\ghdlserver + + SetOutPath $INSTDIR\ngspice-nghdl + CreateDirectory $INSTDIR\ngspice-nghdl\release + SetOutPath $INSTDIR\ngspice-nghdl\release + + Var /GLOBAL shellpath + Var /GLOBAL shellpath1 + Var /GLOBAL cpucores + + ${CPUFeatures.GetCount} $cpucores + + StrCpy $shellpath $INSTDIR + + ${StrRep} '$shellpath1' '$shellpath' '\' '/' + + FileOpen $0 "$INSTDIR\ngspice-nghdl\release\installngspice.sh" w + FileWrite $0 `../configure --with-wingui --enable-xspice --disable-debug --prefix=$shellpath1/ngspice-nghdl/install_dir --exec-prefix=$shellpath1/ngspice-nghdl/install_dir &&$\n` + FileWrite $0 `make -j$cpucores &&$\n` + FileWrite $0 `make install$\n` + FileClose $0 + + nsExec::ExecToLog "$INSTDIR\mingw64\msys\bin\bash.exe installngspice.sh" + Delete "$EXEDIR\ngspice-nghdl.zip" + Delete $INSTDIR\ngspice-nghdl\release\installngspice.sh + + SetOutPath $INSTDIR + + EnVar::SetHKLM + EnVar::AddValue "Path" "$INSTDIR\ngspice-nghdl\install_dir\bin" + Pop $0 + DetailPrint "EnVar::AddValue returned=|$0|" + +SectionEnd + +Section "nghdl-config.ini" + CreateDirectory $PROFILE\.nghdl + FileOpen $0 "$PROFILE\.nghdl\config.ini" w + FileWrite $0 `[NGSPICE]$\n` + FileWrite $0 `NGSPICE_HOME = $INSTDIR\ngspice-nghdl$\n` + FileWrite $0 `DIGITAL_MODEL = %(NGSPICE_HOME)s\src\xspice\icm\ghdl$\n` + FileWrite $0 `RELEASE = %(NGSPICE_HOME)s\release$\n` + FileWrite $0 `[SRC]$\n` + FileWrite $0 `SRC_HOME = $INSTDIR\eSim\nghdl$\n` + FileWrite $0 `LICENSE = %(SRC_HOME)s\LICENSE$\n` + FileWrite $0 `[COMPILER]$\n` + FileWrite $0 `MSYS_HOME = $INSTDIR\mingw64\msys\bin$\n` + FileClose $0 +SectionEnd + +;------------------------------------------------------------------------------------- -- cgit From 27776b92439b26de41df324b4f2cabb73913e661 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Thu, 16 Jul 2020 22:55:25 +0530 Subject: create nghdl.exe and packaging nghdl --- Windows/readme.md | 102 ++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 102 insertions(+) create mode 100644 Windows/readme.md diff --git a/Windows/readme.md b/Windows/readme.md new file mode 100644 index 0000000..10c73f2 --- /dev/null +++ b/Windows/readme.md @@ -0,0 +1,102 @@ +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.7.7", "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 tornado + $ 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 + + Download PyQt4 Wheel from - [https://www.lfd.uci.edu/~gohlke/pythonlibs/#pyqt4] + Where cp37 represents the Python version i.e. 3.7.7 + + > 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 eSim dependencies are available or not: + + $ pip freeze + +> Note : Following dependencies should be available - +> - PyQt4 +> - numpy +> - dateutil +> - pyparsing +> - six +> - cycler.py + + +8. Create spec file as: + + $ pyi-makespec --onefile -n eSim /src/ngspice_ghdl.py + +9. Create onefile executable using pyinstaller as: + + $ pyinstaller -F --clean nghdl.spec + +10. Verify whether all eSim `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? + +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 + - Readme.md + - Workflow.md + +4. Place nghdl folder containing `src folder`, `Examples folder`&`LICENSE`under folder named eSim/ + +5. Compress `eSim` folder in zip format (Make sure that there is folder named `eSim` inside this compressed file) and name it as `nghdl-src.zip`. + +6. Place the following zip files at the installer folder for eSim. +(these can be obtained under *sources/* folder in the repository ) +- nghdl-src.zip +- ghdl.zip +- MSYS.zip +- ngspice-nghdl.zip +- mingw.7z + +7. Place the script `installnghdl.nsi` at the eSim installer location. + +8. 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` file). Now only use the generated installer for distribution. \ No newline at end of file -- cgit From 4c8c9e1448b138c8636a04e31374a385b8960657 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Thu, 16 Jul 2020 22:58:10 +0530 Subject: Update readme.md --- Windows/readme.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/Windows/readme.md b/Windows/readme.md index 10c73f2..7da8684 100644 --- a/Windows/readme.md +++ b/Windows/readme.md @@ -47,7 +47,7 @@ It contains all the documenation for making NGHDL executable (using PyInstaller) - 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 eSim dependencies are available or not: +7. Test whether only NGHDL dependencies are available or not: $ pip freeze @@ -62,13 +62,13 @@ It contains all the documenation for making NGHDL executable (using PyInstaller) 8. Create spec file as: - $ pyi-makespec --onefile -n eSim /src/ngspice_ghdl.py + $ pyi-makespec --onefile -n nghdl /src/ngspice_ghdl.py 9. Create onefile executable using pyinstaller as: $ pyinstaller -F --clean nghdl.spec -10. Verify whether all eSim `src` files (`*.py`) have been included in `Analysis-00.toc` file under the build folder generated by PyInstaller. +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. @@ -99,4 +99,4 @@ It contains all the documenation for making NGHDL executable (using PyInstaller) 7. Place the script `installnghdl.nsi` at the eSim installer location. -8. 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` file). Now only use the generated installer for distribution. \ No newline at end of file +8. 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` file). Now only use the generated installer for distribution. -- cgit From 4ec3aa8dbd9ecf17af8e8dcad0a76fb57525d642 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Thu, 16 Jul 2020 23:00:44 +0530 Subject: Plugins required by NSIS for NGHDL --- Windows/NSISplugins/CPUFeatures.2013-02-26.zip | Bin 0 -> 92286 bytes Windows/NSISplugins/EnVar_plugin.zip | Bin 0 -> 33630 bytes Windows/NSISplugins/Nsis7z_19.00.7z | Bin 0 -> 461078 bytes Windows/NSISplugins/ZipDLL (1).zip | Bin 0 -> 379356 bytes 4 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 Windows/NSISplugins/CPUFeatures.2013-02-26.zip create mode 100644 Windows/NSISplugins/EnVar_plugin.zip create mode 100644 Windows/NSISplugins/Nsis7z_19.00.7z create mode 100644 Windows/NSISplugins/ZipDLL (1).zip diff --git a/Windows/NSISplugins/CPUFeatures.2013-02-26.zip b/Windows/NSISplugins/CPUFeatures.2013-02-26.zip new file mode 100644 index 0000000..2f701d8 Binary files /dev/null and b/Windows/NSISplugins/CPUFeatures.2013-02-26.zip differ diff --git a/Windows/NSISplugins/EnVar_plugin.zip b/Windows/NSISplugins/EnVar_plugin.zip new file mode 100644 index 0000000..cdee545 Binary files /dev/null and b/Windows/NSISplugins/EnVar_plugin.zip differ diff --git a/Windows/NSISplugins/Nsis7z_19.00.7z b/Windows/NSISplugins/Nsis7z_19.00.7z new file mode 100644 index 0000000..78d88ab Binary files /dev/null and b/Windows/NSISplugins/Nsis7z_19.00.7z differ diff --git a/Windows/NSISplugins/ZipDLL (1).zip b/Windows/NSISplugins/ZipDLL (1).zip new file mode 100644 index 0000000..f5c4fc0 Binary files /dev/null and b/Windows/NSISplugins/ZipDLL (1).zip differ -- cgit From 1f4985d7e4cd56ebbd342fc62b89837f57b9eadd Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Thu, 16 Jul 2020 23:10:18 +0530 Subject: GHDL source --- Windows/sources/ghdl.zip | Bin 0 -> 21331447 bytes 1 file changed, 0 insertions(+), 0 deletions(-) create mode 100644 Windows/sources/ghdl.zip diff --git a/Windows/sources/ghdl.zip b/Windows/sources/ghdl.zip new file mode 100644 index 0000000..197414d Binary files /dev/null and b/Windows/sources/ghdl.zip differ -- cgit From d200df270aab304c732adaa7699f8a3a190c5b58 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Thu, 16 Jul 2020 23:36:07 +0530 Subject: Add existing file --- Windows/sources/MSYS.zip | Bin 0 -> 52163263 bytes Windows/sources/mingw.7z | Bin 0 -> 49370037 bytes Windows/sources/nghdl-src.zip | Bin 0 -> 15494597 bytes Windows/sources/ngspice-nghdl.zip | Bin 0 -> 9349804 bytes 4 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 Windows/sources/MSYS.zip create mode 100644 Windows/sources/mingw.7z create mode 100644 Windows/sources/nghdl-src.zip create mode 100644 Windows/sources/ngspice-nghdl.zip diff --git a/Windows/sources/MSYS.zip b/Windows/sources/MSYS.zip new file mode 100644 index 0000000..84ccd49 Binary files /dev/null and b/Windows/sources/MSYS.zip differ diff --git a/Windows/sources/mingw.7z b/Windows/sources/mingw.7z new file mode 100644 index 0000000..9c1eb68 Binary files /dev/null and b/Windows/sources/mingw.7z differ diff --git a/Windows/sources/nghdl-src.zip b/Windows/sources/nghdl-src.zip new file mode 100644 index 0000000..2535bf4 Binary files /dev/null and b/Windows/sources/nghdl-src.zip differ diff --git a/Windows/sources/ngspice-nghdl.zip b/Windows/sources/ngspice-nghdl.zip new file mode 100644 index 0000000..d35f0d2 Binary files /dev/null and b/Windows/sources/ngspice-nghdl.zip differ -- cgit From bb1227724f29143ce52db42f8146f6ab177caab7 Mon Sep 17 00:00:00 2001 From: rahulp13 Date: Mon, 20 Jul 2020 16:46:01 +0530 Subject: update ghdl 0.36 --> 0.37 --- Debian/Ubuntu 16.04+/ghdl-0.36.tar.xz | Bin 3099688 -> 0 bytes Debian/Ubuntu 16.04+/ghdl-0.37.tar.xz | Bin 0 -> 2950196 bytes 2 files changed, 0 insertions(+), 0 deletions(-) delete mode 100644 Debian/Ubuntu 16.04+/ghdl-0.36.tar.xz create mode 100644 Debian/Ubuntu 16.04+/ghdl-0.37.tar.xz 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 Binary files a/Debian/Ubuntu 16.04+/ghdl-0.36.tar.xz and /dev/null differ diff --git a/Debian/Ubuntu 16.04+/ghdl-0.37.tar.xz b/Debian/Ubuntu 16.04+/ghdl-0.37.tar.xz new file mode 100644 index 0000000..2442cb3 Binary files /dev/null and b/Debian/Ubuntu 16.04+/ghdl-0.37.tar.xz differ -- cgit From e18d4e7f10fa5748ccb473052270bc97297b3875 Mon Sep 17 00:00:00 2001 From: rahulp13 Date: Wed, 22 Jul 2020 00:57:33 +0530 Subject: updated packages and added exit on error option --- Debian/Ubuntu 16.04+/install-nghdl.sh | 230 ++++++++++++++-------------------- 1 file changed, 97 insertions(+), 133 deletions(-) diff --git a/Debian/Ubuntu 16.04+/install-nghdl.sh b/Debian/Ubuntu 16.04+/install-nghdl.sh index 4a38418..c7be17f 100755 --- a/Debian/Ubuntu 16.04+/install-nghdl.sh +++ b/Debian/Ubuntu 16.04+/install-nghdl.sh @@ -3,23 +3,38 @@ # FILE: install-nghdl.sh # # USAGE: ./install-nghdl.sh --install -# or +# OR # ./install-nghdl.sh --uninstall # -# DESCRIPTION: It is installation script for Ngspice and GHDL simulators -# (NGHDL) +# 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 31 March 2020 16:30 -# REVISION: --- +# CREATED: Tuesday 02 December 2014 17:01 +# REVISION: Monday 20 July 2020 16:35 #=============================================================================== +set -e # Set exit option immediately on error + +error_exit() { + echo -e "\n\nError! Kindly resolve above errors and try again." + echo -e "\nAborting Installation......\n" +} + +error_skip() { + echo -e "\n\nWarning! Skipping over this error......\n" +} + +# Trap on function error_exit before exiting on error +trap error_exit ERR + + ngspice="ngspice-nghdl" -ghdl="ghdl-0.36" +ghdl="ghdl-0.37" config_dir="$HOME/.nghdl" config_file="config.ini" src_dir=`pwd` @@ -33,94 +48,58 @@ timestamp=`echo $sysdate|awk '{print $3"_"$2"_"$6"_"$4 }'` function installDependency { - echo "Installing dependencies for ghdl-0.36 LLVM................" + echo "Installing dependencies for $ghdl 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 GNAT..........................................." + sudo apt install -y gnat - 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 LLVM-8........................................." + sudo apt install -y llvm-8 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 + 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" + # 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 error_skip ERR + + 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" } @@ -129,59 +108,51 @@ 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/ + + # 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 + + ../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 + # 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 error_skip ERR + + 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................................" } @@ -218,16 +189,9 @@ function createSoftLink 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 + + sudo ln -sf $src_dir/src/ngspice_ghdl.py nghdl echo "Added softlink for NGHDL.................................." cd $pwd @@ -269,9 +233,9 @@ elif [ $option == "--uninstall" ];then 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 + sudo apt-get purge -y llvm-8 + echo "Removing GNAT......................" + sudo apt purge -y gnat else echo "Please select the proper operation." echo "--install" -- cgit From 694cb5d1522bfe450fc9315e9220b71b3dbf12f6 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Wed, 29 Jul 2020 17:48:35 +0530 Subject: Update readme.md --- Windows/readme.md | 42 +++++++++++++++++++++++------------------- 1 file changed, 23 insertions(+), 19 deletions(-) diff --git a/Windows/readme.md b/Windows/readme.md index 7da8684..799e4c9 100644 --- a/Windows/readme.md +++ b/Windows/readme.md @@ -7,7 +7,7 @@ It contains all the documenation for making NGHDL executable (using PyInstaller) ## NGHDL Executable: -1. Download and install "Python-3.7.7", "Git For Windows". Use "Git Bash" for all following shell commands. +1. Download and install "Python-3.5.2", "Git For Windows". Use "Git Bash" for all following shell commands. Reference - https://gitforwindows.org/ @@ -32,7 +32,6 @@ It contains all the documenation for making NGHDL executable (using PyInstaller) - Install PyInstaller, tornado, SetupTools through pip : $ pip install pyinstaller - $ pip install tornado $ 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) : @@ -41,7 +40,7 @@ It contains all the documenation for making NGHDL executable (using PyInstaller) $ pip install Download PyQt4 Wheel from - [https://www.lfd.uci.edu/~gohlke/pythonlibs/#pyqt4] - Where cp37 represents the Python version i.e. 3.7.7 + 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 @@ -53,11 +52,12 @@ It contains all the documenation for making NGHDL executable (using PyInstaller) > Note : Following dependencies should be available - > - PyQt4 -> - numpy -> - dateutil -> - pyparsing -> - six -> - cycler.py +> - sip +> - altgraph +> - future +> - pefile +> - pyinstaller +> - pywin32-ctypes 8. Create spec file as: @@ -73,7 +73,7 @@ It contains all the documenation for making NGHDL executable (using PyInstaller) -## How to package NGHDL? +## How to package NGHDL with eSim ? 1. Place the nghdl.exe generated from the above process at the location /nghdl/src/ @@ -85,18 +85,22 @@ It contains all the documenation for making NGHDL executable (using PyInstaller) - Readme.md - Workflow.md -4. Place nghdl folder containing `src folder`, `Examples folder`&`LICENSE`under folder named eSim/ +4. Place **nghdl** folder containing `src folder`, `Examples folder` & `LICENSE`under folder named eSim/ -5. Compress `eSim` folder in zip format (Make sure that there is folder named `eSim` inside this compressed file) and name it as `nghdl-src.zip`. +5. Final directory structure should be: eSim/nghdl/Examples + eSim/nghdL/src + eSim/nghdl/LICENSE -6. Place the following zip files at the installer folder for eSim. +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 ) -- nghdl-src.zip -- ghdl.zip -- MSYS.zip -- ngspice-nghdl.zip -- mingw.7z +- ghdl.7z +- MSYS.7z +- ngspice-nghdl.7z +- mingw64.7z -7. Place the script `installnghdl.nsi` at the eSim installer location. +8. Place the script `installnghdl.nsi` at the eSim installer location. -8. 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` file). Now only use the generated installer for distribution. +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. -- cgit From f0c7979f4ab41be5c0da7efb095b94bc5e416663 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Wed, 29 Jul 2020 19:04:59 +0530 Subject: Update readme.md --- Windows/readme.md | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/Windows/readme.md b/Windows/readme.md index 799e4c9..6f5aae9 100644 --- a/Windows/readme.md +++ b/Windows/readme.md @@ -82,17 +82,17 @@ It contains all the documenation for making NGHDL executable (using PyInstaller) 3. Remove the following files at /nghdl/ - .gitignore - GHDLside.md - - Readme.md - Workflow.md -4. Place **nghdl** folder containing `src folder`, `Examples folder` & `LICENSE`under folder named eSim/ +4. Place **nghdl** folder containing `src folder`, `Example folder` & `LICENSE` under folder named eSim/ -5. Final directory structure should be: eSim/nghdl/Examples - eSim/nghdL/src - eSim/nghdl/LICENSE +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 ) +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 ) -- cgit From abb503315ba313fcced67962233a04b68367b6bb Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Fri, 31 Jul 2020 11:17:12 +0530 Subject: Changes to made with new Ngspice version --- NgspiceChanges.md | 65 +++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 65 insertions(+) create mode 100644 NgspiceChanges.md diff --git a/NgspiceChanges.md b/NgspiceChanges.md new file mode 100644 index 0000000..5bf5afb --- /dev/null +++ b/NgspiceChanges.md @@ -0,0 +1,65 @@ +# 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/* -- cgit From f5ee0a49642b0b7642f815bbd7e0e7cb4baa403b Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Fri, 31 Jul 2020 23:33:13 +0530 Subject: 7z for increased compression --- Windows/installnghdl.nsi | 30 +++++++++++++++--------------- 1 file changed, 15 insertions(+), 15 deletions(-) diff --git a/Windows/installnghdl.nsi b/Windows/installnghdl.nsi index 0ab7da4..2d5de99 100644 --- a/Windows/installnghdl.nsi +++ b/Windows/installnghdl.nsi @@ -76,52 +76,52 @@ Section "nghdl-loadsource" SetOutPath $EXEDIR - File "ghdl.zip" - File "mingw.7z" - File "MSYS.zip" - File "nghdl-src.zip" - File "ngspice-nghdl.zip" + File "ghdl.7z" + File "mingw64.7z" + File "MSYS.7z" + File "nghdl-src.7z" + File "ngspice-nghdl.7z" SectionEnd Section "nghdl-src" SetOutPath $INSTDIR - ZipDLL::extractall "$EXEDIR\nghdl-src.zip" "$INSTDIR\" + Nsis7z::ExtractWithDetails "$EXEDIR\nghdl-src.7z" "Extracting NGHDL %s..." EnVar::SetHKLM DetailPrint "EnVar::SetHKLM" EnVar::AddValue "Path" "$INSTDIR\eSim\nghdl\src" Pop $0 DetailPrint "EnVar::AddValue returned=|$0|" - Delete "$EXEDIR\nghdl-src.zip" + Delete "$EXEDIR\nghdl-src.7z" SectionEnd Section "nghdl-mingw" SetOutPath $INSTDIR - Nsis7z::ExtractWithDetails "$EXEDIR\mingw.7z" "Extracting MinGW %s..." + Nsis7z::ExtractWithDetails "$EXEDIR\mingw64.7z" "Extracting MinGW %s..." EnVar::SetHKLM EnVar::AddValue "Path" "$INSTDIR\mingw64\bin" Pop $0 DetailPrint "EnVar::AddValue returned=|$0|" - Delete "$EXEDIR\mingw.7z" + Delete "$EXEDIR\mingw64.7z" SectionEnd Section "nghdl-msys" SetOutPath $INSTDIR\mingw64 - ZipDLL::extractall "$EXEDIR\MSYS.zip" "$INSTDIR\mingw64\" + Nsis7z::ExtractWithDetails "$EXEDIR\MSYS.7z" "Extracting MSYS %s..." EnVar::SetHKLM EnVar::AddValue "Path" "$INSTDIR\mingw64\msys\bin" Pop $0 DetailPrint "EnVar::AddValue returned=|$0|" - Delete "$EXEDIR\MSYS.zip" + Delete "$EXEDIR\MSYS.7z" SectionEnd Section "nghdl-GHDL" SetOutPath $INSTDIR\mingw64 - ZipDLL::extractall "$EXEDIR\ghdl.zip" "$INSTDIR\mingw64\" + Nsis7z::ExtractWithDetails "$EXEDIR\ghdl.7z" "Extracting GHDL %s..." EnVar::SetHKLM EnVar::AddValue "Path" "$INSTDIR\mingw64\GHDL\bin" Pop $0 DetailPrint "EnVar::AddValue returned=|$0|" - Delete "$EXEDIR\ghdl.zip" + Delete "$EXEDIR\ghdl.7z" SectionEnd Section "envar-refresh" @@ -133,7 +133,7 @@ SectionEnd Section "nghdl-installNgspice" SetOutPath $INSTDIR - ZipDLL::extractall "$EXEDIR\ngspice-nghdl.zip" "$INSTDIR\" + Nsis7z::ExtractWithDetails "$EXEDIR\ngspice-nghdl.7z" "Extracting GHDL %s..." CopyFiles $INSTDIR\eSim\nghdl\src\outitf.c $INSTDIR\ngspice-nghdl\src\frontend @@ -160,7 +160,7 @@ Section "nghdl-installNgspice" FileClose $0 nsExec::ExecToLog "$INSTDIR\mingw64\msys\bin\bash.exe installngspice.sh" - Delete "$EXEDIR\ngspice-nghdl.zip" + Delete "$EXEDIR\ngspice-nghdl.7z" Delete $INSTDIR\ngspice-nghdl\release\installngspice.sh SetOutPath $INSTDIR -- cgit From 2e7c1591ed1ed6e181521182dd1763056572e661 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Fri, 31 Jul 2020 23:34:13 +0530 Subject: Delete MSYS.zip --- Windows/sources/MSYS.zip | Bin 52163263 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 Windows/sources/MSYS.zip diff --git a/Windows/sources/MSYS.zip b/Windows/sources/MSYS.zip deleted file mode 100644 index 84ccd49..0000000 Binary files a/Windows/sources/MSYS.zip and /dev/null differ -- cgit From 0f22172d72efc06f7fda409c8e35d6f2a54091c6 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Fri, 31 Jul 2020 23:34:42 +0530 Subject: Delete ghdl.zip --- Windows/sources/ghdl.zip | Bin 21331447 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 Windows/sources/ghdl.zip diff --git a/Windows/sources/ghdl.zip b/Windows/sources/ghdl.zip deleted file mode 100644 index 197414d..0000000 Binary files a/Windows/sources/ghdl.zip and /dev/null differ -- cgit From 5eec6521ce630403b9cb5cb33e3940a4b57879a3 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Fri, 31 Jul 2020 23:34:50 +0530 Subject: Delete mingw.7z --- Windows/sources/mingw.7z | Bin 49370037 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 Windows/sources/mingw.7z diff --git a/Windows/sources/mingw.7z b/Windows/sources/mingw.7z deleted file mode 100644 index 9c1eb68..0000000 Binary files a/Windows/sources/mingw.7z and /dev/null differ -- cgit From e8d3d12bc0a381e803b2337af94969a2758a65ce Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Fri, 31 Jul 2020 23:35:00 +0530 Subject: Delete nghdl-src.zip --- Windows/sources/nghdl-src.zip | Bin 15494597 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 Windows/sources/nghdl-src.zip diff --git a/Windows/sources/nghdl-src.zip b/Windows/sources/nghdl-src.zip deleted file mode 100644 index 2535bf4..0000000 Binary files a/Windows/sources/nghdl-src.zip and /dev/null differ -- cgit From 2af7b9153c1c9adc53dac76e8784311e62ee112c Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Fri, 31 Jul 2020 23:35:09 +0530 Subject: Delete ngspice-nghdl.zip --- Windows/sources/ngspice-nghdl.zip | Bin 9349804 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 Windows/sources/ngspice-nghdl.zip diff --git a/Windows/sources/ngspice-nghdl.zip b/Windows/sources/ngspice-nghdl.zip deleted file mode 100644 index d35f0d2..0000000 Binary files a/Windows/sources/ngspice-nghdl.zip and /dev/null differ -- cgit From 4bb2079a4f94e0fd6446f2abcd8df86f6427499b Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Fri, 31 Jul 2020 23:35:29 +0530 Subject: Create sources --- Windows/sources | 1 + 1 file changed, 1 insertion(+) create mode 100644 Windows/sources diff --git a/Windows/sources b/Windows/sources new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/Windows/sources @@ -0,0 +1 @@ + -- cgit From 705880606aa60b897040dd37d9bd5f9ff56a77b3 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Fri, 31 Jul 2020 23:35:46 +0530 Subject: Delete sources --- Windows/sources | 1 - 1 file changed, 1 deletion(-) delete mode 100644 Windows/sources diff --git a/Windows/sources b/Windows/sources deleted file mode 100644 index 8b13789..0000000 --- a/Windows/sources +++ /dev/null @@ -1 +0,0 @@ - -- cgit From 64b6576e0770258f599c9ec7eb8c4dc5bba18a4d Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Sat, 1 Aug 2020 10:50:12 +0530 Subject: sources compressed using 7z --- Windows/sources/MSYS.7z | Bin 0 -> 8449807 bytes Windows/sources/ghdl.7z | Bin 0 -> 10968564 bytes Windows/sources/mingw64.7z | Bin 0 -> 16720325 bytes Windows/sources/ngspice-nghdl.7z | Bin 0 -> 3725876 bytes 4 files changed, 0 insertions(+), 0 deletions(-) create mode 100644 Windows/sources/MSYS.7z create mode 100644 Windows/sources/ghdl.7z create mode 100644 Windows/sources/mingw64.7z create mode 100644 Windows/sources/ngspice-nghdl.7z diff --git a/Windows/sources/MSYS.7z b/Windows/sources/MSYS.7z new file mode 100644 index 0000000..c113d5f Binary files /dev/null and b/Windows/sources/MSYS.7z differ diff --git a/Windows/sources/ghdl.7z b/Windows/sources/ghdl.7z new file mode 100644 index 0000000..f403f6e Binary files /dev/null and b/Windows/sources/ghdl.7z differ diff --git a/Windows/sources/mingw64.7z b/Windows/sources/mingw64.7z new file mode 100644 index 0000000..41b0a98 Binary files /dev/null and b/Windows/sources/mingw64.7z differ diff --git a/Windows/sources/ngspice-nghdl.7z b/Windows/sources/ngspice-nghdl.7z new file mode 100644 index 0000000..aaee3be Binary files /dev/null and b/Windows/sources/ngspice-nghdl.7z differ -- cgit From 4cd9040bba306c9c42e815c0afcba5f95783e045 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Mon, 3 Aug 2020 16:11:12 +0530 Subject: MinGW + MSYS --- Windows/MinGW+MSYS.md | 27 +++++++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 Windows/MinGW+MSYS.md diff --git a/Windows/MinGW+MSYS.md b/Windows/MinGW+MSYS.md new file mode 100644 index 0000000..d2f682a --- /dev/null +++ b/Windows/MinGW+MSYS.md @@ -0,0 +1,27 @@ +# MinGW + MSYS - Build environment for Ngspice on Windows +> MSYS provides a Linux like shell and all the utilities required during the configure-make-make install process of Ngspice on Windows. + +> MinGW provides the GCC compiler required to build the Ngspice executable. + +[Download MinGW (unmodified)](https://sourceforge.net/projects/mingw-w64/files/Toolchains%20targetting%20Win64/Personal%20Builds/mingw-builds/8.1.0/threads-posix/seh/x86_64-8.1.0-release-posix-seh-rt_v6-rev0.7z)\ +[Download MSYS (unmodified)](https://sourceforge.net/projects/mingw-w64/files/External%20binary%20packages%20%28Win64%20hosted%29/MSYS%20%2832-bit%29/MSYS-20111123.zip/download) + +**Reduced versions of MinGW and MSYS for NGHDL can be found in this repository under `sources/` folder.** + +## Usage of MinGW + MSYS +1. Add `/mingw64/bin/` and `/mingw64/msys/bin` to the path so that all the utilities are able to find each other. +2. Open Windows command prompt at the location you want to use `MinGW + MSYS`. +3. Execute the command to launch `bash` provided by MSYS at this location. + ```sh + > pathtoMSYS/bin/bash.exe + ``` + 4. This comand launches bash in the CMD window which can then be used as `BASH shell`, with commands similar to Linux. + + +## Reduction of MinGW + MSYS +> Originally MinGW and MSYS are provided for a large variety of development scenarios which are not required by NGHDL, causing size overheads in the final distribution. + +1. To remove unrequired parts of MSYS and MinGW, a trial and error based approach is to be followed. + +2. To start, both utilities should be reduced to the bare minimum required components which can be noted by studying the Ngspice configure file `(/ngspice/configure)`. +The rest of the utilities are to added by accessing the errors in the logs provided during the configure-make-make install process. -- cgit From a64e48e777e3c95ca720b3225ee5262b0f1aa956 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Wed, 5 Aug 2020 22:08:04 +0530 Subject: Update readme.md --- Windows/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Windows/readme.md b/Windows/readme.md index 6f5aae9..cb39499 100644 --- a/Windows/readme.md +++ b/Windows/readme.md @@ -29,7 +29,7 @@ It contains all the documenation for making NGHDL executable (using PyInstaller) 6. Install all Python dependencies for NGHDL within the virtual environment as: - - Install PyInstaller, tornado, SetupTools through pip : + - Install PyInstaller, SetupTools through pip : $ pip install pyinstaller $ pip install --upgrade 'setuptools<45.0.0' -- cgit From ec19a271375aa1063456ba81012446c9d629b087 Mon Sep 17 00:00:00 2001 From: rahulp13 Date: Thu, 6 Aug 2020 00:56:02 +0530 Subject: reorganized files --- Debian/Ubuntu 14.04/ghdl-0.36.tar.xz | Bin 9290484 -> 0 bytes Debian/Ubuntu 14.04/install-nghdl.sh | 277 ---------------------------------- Debian/Ubuntu 16.04+/ghdl-0.37.tar.xz | Bin 2950196 -> 0 bytes Debian/Ubuntu 16.04+/install-nghdl.sh | 243 ----------------------------- Debian/nghdl.spec | 32 ---- Debian/readme.md | 156 ------------------- README.md | 15 ++ Ubuntu/README.md | 156 +++++++++++++++++++ Ubuntu/ghdl-0.37.tar.xz | Bin 0 -> 2950196 bytes Ubuntu/install-nghdl.sh | 243 +++++++++++++++++++++++++++++ Ubuntu/nghdl.spec | 32 ++++ readme.md | 15 -- 12 files changed, 446 insertions(+), 723 deletions(-) delete mode 100644 Debian/Ubuntu 14.04/ghdl-0.36.tar.xz delete mode 100755 Debian/Ubuntu 14.04/install-nghdl.sh delete mode 100644 Debian/Ubuntu 16.04+/ghdl-0.37.tar.xz delete mode 100755 Debian/Ubuntu 16.04+/install-nghdl.sh delete mode 100644 Debian/nghdl.spec delete mode 100644 Debian/readme.md create mode 100644 README.md create mode 100644 Ubuntu/README.md create mode 100644 Ubuntu/ghdl-0.37.tar.xz create mode 100755 Ubuntu/install-nghdl.sh create mode 100644 Ubuntu/nghdl.spec delete mode 100644 readme.md 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 Binary files a/Debian/Ubuntu 14.04/ghdl-0.36.tar.xz and /dev/null 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.37.tar.xz b/Debian/Ubuntu 16.04+/ghdl-0.37.tar.xz deleted file mode 100644 index 2442cb3..0000000 Binary files a/Debian/Ubuntu 16.04+/ghdl-0.37.tar.xz and /dev/null differ diff --git a/Debian/Ubuntu 16.04+/install-nghdl.sh b/Debian/Ubuntu 16.04+/install-nghdl.sh deleted file mode 100755 index c7be17f..0000000 --- a/Debian/Ubuntu 16.04+/install-nghdl.sh +++ /dev/null @@ -1,243 +0,0 @@ -#!/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: Monday 20 July 2020 16:35 -#=============================================================================== - -set -e # Set exit option immediately on error - -error_exit() { - echo -e "\n\nError! Kindly resolve above errors and try again." - echo -e "\nAborting Installation......\n" -} - -error_skip() { - echo -e "\n\nWarning! Skipping over this error......\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" - # 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 error_skip ERR - - 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 - - ../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 error_skip ERR - - 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/Debian/nghdl.spec deleted file mode 100644 index 61f3fa8..0000000 --- a/Debian/nghdl.spec +++ /dev/null @@ -1,32 +0,0 @@ -# -*- mode: python ; coding: utf-8 -*- - -block_cipher = None - -a = Analysis(['nghdl/src/ngspice_ghdl.py'], - pathex=['/home/rahul/Music'], - binaries=[], - datas=[], - hiddenimports=['PyQt4.sip'], - hookspath=[], - runtime_hooks=[], - excludes=[], - win_no_prefer_redirects=False, - win_private_assemblies=False, - cipher=block_cipher, - noarchive=False) -pyz = PYZ(a.pure, a.zipped_data, - cipher=block_cipher) -exe = EXE(pyz, - a.scripts, - a.binaries, - a.zipfiles, - a.datas, - [], - name='nghdl', - debug=False, - bootloader_ignore_signals=False, - strip=False, - upx=True, - upx_exclude=[], - runtime_tmpdir=None, - console=True ) 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 /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/README.md b/README.md new file mode 100644 index 0000000..b86b7c3 --- /dev/null +++ b/README.md @@ -0,0 +1,15 @@ +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-` folder. diff --git a/Ubuntu/README.md b/Ubuntu/README.md new file mode 100644 index 0000000..04e3647 --- /dev/null +++ b/Ubuntu/README.md @@ -0,0 +1,156 @@ +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 /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/Ubuntu/ghdl-0.37.tar.xz b/Ubuntu/ghdl-0.37.tar.xz new file mode 100644 index 0000000..2442cb3 Binary files /dev/null and b/Ubuntu/ghdl-0.37.tar.xz differ diff --git a/Ubuntu/install-nghdl.sh b/Ubuntu/install-nghdl.sh new file mode 100755 index 0000000..c7be17f --- /dev/null +++ b/Ubuntu/install-nghdl.sh @@ -0,0 +1,243 @@ +#!/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: Monday 20 July 2020 16:35 +#=============================================================================== + +set -e # Set exit option immediately on error + +error_exit() { + echo -e "\n\nError! Kindly resolve above errors and try again." + echo -e "\nAborting Installation......\n" +} + +error_skip() { + echo -e "\n\nWarning! Skipping over this error......\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" + # 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 error_skip ERR + + 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 + + ../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 error_skip ERR + + 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/Ubuntu/nghdl.spec b/Ubuntu/nghdl.spec new file mode 100644 index 0000000..61f3fa8 --- /dev/null +++ b/Ubuntu/nghdl.spec @@ -0,0 +1,32 @@ +# -*- mode: python ; coding: utf-8 -*- + +block_cipher = None + +a = Analysis(['nghdl/src/ngspice_ghdl.py'], + pathex=['/home/rahul/Music'], + binaries=[], + datas=[], + hiddenimports=['PyQt4.sip'], + hookspath=[], + runtime_hooks=[], + excludes=[], + win_no_prefer_redirects=False, + win_private_assemblies=False, + cipher=block_cipher, + noarchive=False) +pyz = PYZ(a.pure, a.zipped_data, + cipher=block_cipher) +exe = EXE(pyz, + a.scripts, + a.binaries, + a.zipfiles, + a.datas, + [], + name='nghdl', + debug=False, + bootloader_ignore_signals=False, + strip=False, + upx=True, + upx_exclude=[], + runtime_tmpdir=None, + console=True ) 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-` folder. -- cgit From f9f56ff487b16c312143bd4e81949f4f5db1e9e8 Mon Sep 17 00:00:00 2001 From: rahulp13 Date: Thu, 6 Aug 2020 01:55:36 +0530 Subject: updated doc files --- NgspiceChanges.md | 65 ------------------- Ngspice_Version_Change.md | 68 ++++++++++++++++++++ README.md | 16 ++--- Ubuntu/README.md | 159 ++++------------------------------------------ Windows/README.md | 106 +++++++++++++++++++++++++++++++ Windows/readme.md | 106 ------------------------------- 6 files changed, 196 insertions(+), 324 deletions(-) delete mode 100644 NgspiceChanges.md create mode 100644 Ngspice_Version_Change.md create mode 100644 Windows/README.md delete mode 100644 Windows/readme.md 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 index b86b7c3..b9bbb59 100644 --- a/README.md +++ b/README.md @@ -1,15 +1,15 @@ -NGHDL Installers +NGHDL Packaging ==== -It contains all the documenation for making installations on various platforms. +It contains all the documentation for packaging NGHDL to be distributed with [eSim](https://github.com/fossee/esim). -## How to package NGHDL with eSim? -1. Add GHDL executable and the corresponding installer for the target OS in the `nghdl` folder. +## Packaging NGHDL with eSim? -> Note : Instructions on how to generate NGHDL executable and distribute it along with GHDL are -> provided under respective target OS directory. +1. NGHDL is currently packaged for Ubuntu OS (Linux) and MS Windows OS. -2. Rename `nghdl` folder as `nghdl-master` and compress it to `.zip` format. +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. Place this compressed file in `eSim-` folder. +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 index 04e3647..cbc0adb 100644 --- a/Ubuntu/README.md +++ b/Ubuntu/README.md @@ -1,156 +1,25 @@ NGHDL Installer (Ubuntu OS) ==== +It contains the documentation to package NGHDL for 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. +> 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? -## NGDHL EXECUTABLE: +1. Take the `master` branch containing the source code. Rename the folder to `nghdl`. -1. Download `virtualenv` package and create virtual environment as: +2. Add GHDL source code `ghdl-.tar.xz` in the `nghdl` folder. - $ pip install virtualenv - $ virtualenv -p /usr/bin/python3 nghdl +3. Add the installer script `install-nghdl.sh` in the `nghdl` folder. - OR - - $ sudo apt install -y python3-venv - $ python3 -m venv nghdl +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. Activate the virtual environment as: - - $ source nghdl/bin/activate +2. Compress it to `.zip` format. -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 /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 +3. Place this compressed file in `eSim-` folder. 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 + + 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 /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/Windows/readme.md b/Windows/readme.md deleted file mode 100644 index 6f5aae9..0000000 --- a/Windows/readme.md +++ /dev/null @@ -1,106 +0,0 @@ -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 - - 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 /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. -- cgit From c4c8fe16b8d682a0d06732fe513fc6550030c2df Mon Sep 17 00:00:00 2001 From: rahulp13 Date: Thu, 6 Aug 2020 01:55:54 +0530 Subject: initial commit --- Ubuntu/executable.md | 94 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 94 insertions(+) create mode 100644 Ubuntu/executable.md 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 /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` -- cgit From 514efd4c9031bb57df374eb1359282268f9ca478 Mon Sep 17 00:00:00 2001 From: rahulp13 Date: Thu, 6 Aug 2020 02:00:55 +0530 Subject: inherit ERR trap by shell functions and updated trap functions --- Ubuntu/install-nghdl.sh | 19 ++++++++----------- 1 file changed, 8 insertions(+), 11 deletions(-) diff --git a/Ubuntu/install-nghdl.sh b/Ubuntu/install-nghdl.sh index c7be17f..47fdb10 100755 --- a/Ubuntu/install-nghdl.sh +++ b/Ubuntu/install-nghdl.sh @@ -15,18 +15,15 @@ # AUTHOR: Fahim Khan, Rahul Paknikar # ORGANIZATION: eSim, FOSSEE group at IIT Bombay # CREATED: Tuesday 02 December 2014 17:01 -# REVISION: Monday 20 July 2020 16:35 +# 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 errors and try again." - echo -e "\nAborting Installation......\n" -} - -error_skip() { - echo -e "\n\nWarning! Skipping over this error......\n" + 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 @@ -91,7 +88,7 @@ function installDependency sudo make install set +e # Temporary disable exit on error - trap error_skip ERR + trap "" ERR # Do not trap on error of any command echo "Removing unused part of $ghdl LLVM" sudo rm -rf ../$ghdl @@ -137,7 +134,7 @@ function installNgspice sudo chmod 755 $HOME/$ngspice/install_dir/bin/ngspice set +e # Temporary disable exit on error - trap error_skip ERR + trap "" ERR # Do not trap on error of any command echo "Removing previously installed Ngspice (if any)" sudo apt-get purge -y ngspice @@ -152,7 +149,7 @@ function installNgspice trap error_exit ERR sudo ln -sf $HOME/$ngspice/install_dir/bin/ngspice /usr/bin/ngspice - echo "Added softlink for Ngspice................................" + echo "Added softlink for Ngspice..." } @@ -192,7 +189,7 @@ function createSoftLink fi sudo ln -sf $src_dir/src/ngspice_ghdl.py nghdl - echo "Added softlink for NGHDL.................................." + echo "Added softlink for NGHDL..." cd $pwd -- cgit From 4e4d9e8285cbf9cedde362acf82ab79fdc5497d1 Mon Sep 17 00:00:00 2001 From: rahulp13 Date: Thu, 6 Aug 2020 02:02:39 +0530 Subject: added executable permission for configure of ghdl and ngspice --- Ubuntu/install-nghdl.sh | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Ubuntu/install-nghdl.sh b/Ubuntu/install-nghdl.sh index 47fdb10..fcb3eab 100755 --- a/Ubuntu/install-nghdl.sh +++ b/Ubuntu/install-nghdl.sh @@ -45,7 +45,7 @@ timestamp=`echo $sysdate|awk '{print $3"_"$2"_"$6"_"$4 }'` function installDependency { - echo "Installing dependencies for $ghdl LLVM...................." + echo "Installing dependencies for $ghdl LLVM................" echo "Installing Make..........................................." sudo apt install -y make @@ -75,12 +75,13 @@ function installDependency sudo apt install -y libxaw7-dev - echo "Installing $ghdl LLVM....................................." + 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" @@ -122,6 +123,7 @@ function installNgspice 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 -- cgit From b05ed92da35bb7e1e0c09ffc9616465cc30cae94 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Thu, 6 Aug 2020 18:33:44 +0530 Subject: Update readme.md --- Windows/readme.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Windows/readme.md b/Windows/readme.md index cb39499..f63e717 100644 --- a/Windows/readme.md +++ b/Windows/readme.md @@ -98,9 +98,10 @@ It contains all the documenation for making NGHDL executable (using PyInstaller) (these can be obtained under *sources/* folder in the repository ) - ghdl.7z - MSYS.7z -- ngspice-nghdl.7z - mingw64.7z +- ngspice-nghdl.7z ( this file can be obtained by decompressing `ngspice-nghdl.tar.xz` file present at `master branch` of this repository and recompressing using 7z tool) + 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. -- cgit From f1056e2b9b752470d5434d19da65195f8ba70b10 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Thu, 6 Aug 2020 18:34:07 +0530 Subject: Delete ngspice-nghdl.7z --- Windows/sources/ngspice-nghdl.7z | Bin 3725876 -> 0 bytes 1 file changed, 0 insertions(+), 0 deletions(-) delete mode 100644 Windows/sources/ngspice-nghdl.7z diff --git a/Windows/sources/ngspice-nghdl.7z b/Windows/sources/ngspice-nghdl.7z deleted file mode 100644 index aaee3be..0000000 Binary files a/Windows/sources/ngspice-nghdl.7z and /dev/null differ -- cgit From 61fd2a0cec774a9076b1e45c53973a037d333147 Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Thu, 6 Aug 2020 19:15:11 +0530 Subject: Delete readme.md --- Windows/readme.md | 107 ------------------------------------------------------ 1 file changed, 107 deletions(-) delete mode 100644 Windows/readme.md diff --git a/Windows/readme.md b/Windows/readme.md deleted file mode 100644 index f63e717..0000000 --- a/Windows/readme.md +++ /dev/null @@ -1,107 +0,0 @@ -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, 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 - - 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 /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 -- mingw64.7z - -- ngspice-nghdl.7z ( this file can be obtained by decompressing `ngspice-nghdl.tar.xz` file present at `master branch` of this repository and recompressing using 7z tool) - -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. -- cgit From 87f2b459db9251df785b079ae97180f87d0d769b Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Thu, 6 Aug 2020 19:18:14 +0530 Subject: Update README.md --- Windows/README.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/Windows/README.md b/Windows/README.md index 6f5aae9..bf3e7ca 100644 --- a/Windows/README.md +++ b/Windows/README.md @@ -98,9 +98,10 @@ It contains all the documenation for making NGHDL executable (using PyInstaller) (these can be obtained under *sources/* folder in the repository ) - ghdl.7z - MSYS.7z -- ngspice-nghdl.7z - mingw64.7z +- ngspice-nghdl.7z ( this file can be obtained by decompressing `ngspice-nghdl.tar.xz` file present at `master branch` of this repository and recompressing using 7z tool) + 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. -- cgit From 335ae3ddf3910315dda1cf274054b40635c304fe Mon Sep 17 00:00:00 2001 From: Bladen Martin Date: Thu, 6 Aug 2020 19:20:06 +0530 Subject: Update README.md --- Windows/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/Windows/README.md b/Windows/README.md index bf3e7ca..f63e717 100644 --- a/Windows/README.md +++ b/Windows/README.md @@ -29,7 +29,7 @@ It contains all the documenation for making NGHDL executable (using PyInstaller) 6. Install all Python dependencies for NGHDL within the virtual environment as: - - Install PyInstaller, tornado, SetupTools through pip : + - Install PyInstaller, SetupTools through pip : $ pip install pyinstaller $ pip install --upgrade 'setuptools<45.0.0' -- cgit