Merge pull request #160 from rahulp13/manualm2.1

updated manual for release v2.1

7 files changed, 99 insertions, 19 deletions

diff --git a/Appendix.tex b/Appendix.tex
index 486e2558..bd7b7981 100644
--- a/Appendix.tex
+++ b/Appendix.tex
@@ -118,7 +118,8 @@ Review global labels in hierarchy to find possible duplicates, watch for similar
 \item Port declaration can be either \textbf{std\_logic} or \textbf{std\_logic\_vector}. No other declarations are allowed.
 \item All \textbf{in} ports should be declared before \textbf{out} ports.
 \item Maximum number of output ports that a VHDL entity under simulation can have is 64, provided the port names are not too lengthy to overflow the buffer.
-\item Be extremely careful while dealing with Arithmetic Operations. (See \textbf{nghdl/Example/ \\ counter/counter.vhdl} for further reference)
+\item Be extremely careful while dealing with Arithmetic Operations. \\ 
+(See \textbf{nghdl/Example/counter/counter.vhdl} for further reference)
 \item If structural style is used, then the main entity of your VHDL code which is to be simulated,  should be declared first in the file with inclusion of libraries for subsequent declaration of each supporting entity.
 See \textbf{nghdl/Example/full\_adder/ \\ full\_adder\_structural.vhdl} for further reference.
 \item Do not use \texttt{sudo} or root permissions while working Mixed-Mode Simulation and eSim.
@@ -289,19 +290,24 @@ If you want to delete a model from your file system or is deleted due to unavoid
 \item [1] A. S. Sedra and K. C. Smith, Microelectronic Circuits - Theory and Applications. Oxford University Press, 2009. 
 \item [2] K. M. Moudgalya, “Spoken Tutorial: A Collaborative and Scalable Education Technology,” CSI Communications, vol. 35, no. 6, pp. 10–12, September 2011, available at https://spoken-tutorial.org/CSI.pdf. 
 \item [3] (2020, March). [Online]. Available: https://www.scilab.org/ 
-\item [4] (2020, March). [Online]. Available: https://scilab-test.garudaindia.in/scilab\_in/,https://scilab-test.garudaindia.in/cloud 
+\item [4] (2020, March). [Online].
+Available: https://scilab-test.garudaindia.in/scilab\_in/ \\
+https://scilab-test.garudaindia.in/cloud 
 \item [6]  K. Kannan and K. Narayanan, “Ict-enabled scalable workshops for engineering college teachers in india,” in Post-Secondary Education and Technology: A Global Perspective on Opportunities and Obstacles to Development (International and Development Education), R. Clohey, S. Austin-Li, and J. C. Weldman, Eds. Palgrave Macmillan, 2012. 
 \item [7]  (2020, March). [Online]. Available: https://esim.fossee.in 
 \item [8] (2020, March). [Online]. Available: http://www.aakashlabs.org/ 
-\item [9] (2020, March). [Online]. Available: http://en.wikipedia.org/wiki/Electronic\_design\_automation
+\item [9] (2020, March). [Online]. \\
+Available: http://en.wikipedia.org/wiki/Electronic\_design\_automation
 \item [10] (2020, March) Synaptic Package Manager Spoken Tutorial. [Online]. Available: https://www.spoken-tutorial.org/tutorial-search/?search\_foss=Linux&search\_language=English 
 \item [11] (2020, March). [Online]. Available: https://www.kicad-pcb.org/
 \item [12] (2020, March). [Online]. Available: ngspice.sourceforge.net/
 \item [13] (2020, March). [Online]. Available: http://scilab.in/ 
 \item [14]   S. M. Sandler and C. Hymowitz, SPICE Circuit Handbook. New York: McGraw-Hill Professional, 2006. 
 \item [15]   J.-P. Charras and F. Tappero. (2020, March). [Online]. Available: https://docs.kicad-pcb.org/
-\item [16] Wayne Stambaugh (2020, March). [Online]. Available: https://launchpad.net/kicad/4.0/4.0.7 
-\item   [17]   P. Nenzi and H. Vogt. (2020) Ngspice users manual version 31. [Online]. Available: http://ngspice.sourceforge.net/docs/ngspice-manual.pdf 
+\item [16] Wayne Stambaugh (2020, March). [Online]. \\
+Available: https://launchpad.net/kicad/4.0/4.0.7 
+\item   [17]   P. Nenzi and H. Vogt. (2020) Ngspice users manual version 31. [Online]. \\
+Available: http://ngspice.sourceforge.net/docs/ngspice-manual.pdf 
 \item [18]   K. M. Moudgalya, “LATEX Training through Spoken Tutorials,” TUGboat, vol. 32, no. 3, pp. 251–257, 2011. 
 \item [19]   (2020, March). [Online]. Available: https://www.spoken-tutorial.org/ 
 \end{enumerate}
diff --git a/acknowledgement.tex b/acknowledgement.tex
new file mode 100644
index 00000000..50842c11
--- /dev/null
+++ b/acknowledgement.tex
@@ -0,0 +1,63 @@
+\section*{Acknowledgement}
+
+There  have  been  many  people contributing towards the software development and/or the electronic system design and simulation for eSim. The following people have contributed in some way.
+
+\subsection*{Development:}
+\begin{multicols}{3}
+\begin{itemize}
+    \item Fahim Khan
+    \item Rahul Paknikar
+    \item Saurabh Bansode
+    \item Gloria Nandihal
+    \item Athul George
+    \item Gaurav Supal
+    \item Kayva Manohar
+    \item Komal Sheth
+
+
+    \item Ashutosh Jha
+    \item Sumanto Kar
+    \item Shubhangi Mahajan
+    \item Vadissa Yamini
+    \item Bladen Martin
+    \item Aamir Thekiya
+    
+    
+    \item Neel Manilal Shah
+    \item Padigepati Mallikarjuna Reddy
+    \item Bhargav Katakam
+    \item Anjali Jaiswal
+    \item Mahfooz Ahmad
+    
+    \item Mudit Joshi
+    \item Ashutosh Gangwar
+    \item Akshay NH
+    \item Athul MS
+    
+    
+    \item Powai Labs Technology Private Limited
+
+\end{itemize}
+\end{multicols}
+
+\subsection*{Technical Guidance}
+\begin{multicols}{2}
+\begin{itemize}
+    \item Kannan M. Moudgalya
+    \item Pramod Murali
+    \item Madhav P. Desai
+    \item Usha Vishwanathan
+    \item Rupak Rokade
+    \item Sunil Shetye
+\end{itemize}
+\end{multicols}
+\subsection*{Financial Sponsorship:}
+\begin{multicols}{2}
+\begin{itemize}
+    \item NMEICT, MHRD, Govt. Of India
+    \item MHRD, Govt. Of India
+    \item Indian Institute of Technology, Bombay
+\end{itemize}
+\end{multicols}
+
+If someone helped in the development/simulation and has not been inserted in this list, then this omission was unintentional. If you feel you should be on this list then please write to \href{mailto:contact-esim@fossee.in}{contact-esim@fossee.in}.  Do not be shy, we  would  like  to  make  this  list  as  complete  as possible.
diff --git a/chap_3.tex b/chap_3.tex
index 210573b7..25b9ca43 100644
--- a/chap_3.tex
+++ b/chap_3.tex
@@ -6,10 +6,10 @@
 \begin{enumerate}
 \item Download eSim installer for Linux from {\tt http://esim.fossee.in/downloads} to a local directory and unpack it. You can also unpack the  installer through the terminal. Open the terminal and navigate to the directory where this INSTALL file is located. Use the following command to unpack:
 \\
-\quad {\tt \$ unzip eSim-2.0.zip}
+\quad {\tt \$ unzip eSim-2.1.zip}
 \item To install eSim and other dependencies run the following command:
 \\
- \quad {\tt \$ cd eSim-2.0 \newline \$ chmod +x install-eSim.sh \newline \$ ./install-eSim.sh --install}
+ \quad {\tt \$ cd eSim-2.1 \newline \$ chmod +x install-eSim.sh \newline \$ ./install-eSim.sh --install}
 \item To run eSim from the terminal, type:  
 \\
 \quad {\tt \$ esim}
@@ -20,7 +20,7 @@
 
 \section {eSim installation in Windows OS}
 \begin{enumerate}
-\item Download \textbf{eSim-2.0\_install.exe} from  {\tt https://esim.fossee.in/downloads}
+\item Download \textbf{eSim-2.1\_install.exe} from  {\tt https://esim.fossee.in/downloads}
 \item Disable the antivirus (if any). Now, double click on the exe file to start the installation process. If a window appears, click {\tt Yes} to complete the installation.
 \item By default eSim will be installed in C drive, under an auto-generated FOSSEE Folder. Note that installation directory can neither be in "Program Files" nor contain spaces in its path.
 \item \textbf{eSim} icon will be created on desktop. You can double click on the {\tt eSim} icon created on the Desktop after installation.
diff --git a/chap_9.tex b/chap_9.tex
index c9f79270..e0b0f0ea 100644
--- a/chap_9.tex
+++ b/chap_9.tex
@@ -1,17 +1,17 @@
-\chapter{NGHDL-Mixed mode simulation}
+\chapter{NGHDL-Mixed Signal Simulation}
 \label{chap9}
 \thispagestyle{empty}
 
 
-NGHDL feature facilitates creation of user-defined models for mixed-mode circuit simulation in eSim. By interfacing GHDL and Ngspice, we achieve mixed-mode simulation. Digital models are simulated using GHDL and XSpice engine of Ngspice. \\
+NGHDL feature facilitates creation of user-defined models for mixed-signal circuit simulation in eSim. By interfacing GHDL and Ngspice, we achieve mixed-signal simulation. Digital models are simulated using GHDL and XSpice engine of Ngspice. \\
+
 
-Note : NGHDL feature as of March 2020, is available only for Linux OS users, under Ubuntu 16.04 and Ubuntu 18.04 distributions
 %To access NGHDL click on the NGHDL button on the left pane of window as shown in figure \figref{screen3}:
 %\pagebreak
 
 \section{Introduction}
 
-Ngspice supports mixed mode simulation, i.e. it can simulate both digital and analog component. It defines a \texttt{model} which has the functionality of the circuit component, which can be used in the netlist.
+Ngspice supports mixed-signal simulation, i.e. it can simulate both digital and analog component. It defines a \texttt{model} which has the functionality of the circuit component, which can be used in the netlist.
 For example you can create an \texttt{adder} model in Ngspice and use it in any circuit netlist of Ngspice. \\
 
 However, it is not feasible to define complex digital models without a complete understanding of Ngspice and XSPICE architectures and is a time-consuming process. Also, most of the users are familiar with GHDL and can write the models using VHDL code with ease.
@@ -51,7 +51,7 @@ Hence, NGHDL provides an  interface to write VHDL code for a digital model and i
         \end{figure}
 
 
-\item Now browse and locate the VHDL file to upload. Select the VHDL file and click on the Upload button. This process will create Ngspice model and corresponding component drawing inside the KiCad library (eSim\_Nghdl.lib) of the VHDL block to be used in mixed-mode simulations. An acknowledgement message will appear upon sucessful processing of the VHDL code as shown in \figref{upload}. \\
+\item Now browse and locate the VHDL file to upload. Select the VHDL file and click on the Upload button. This process will create Ngspice model and corresponding component drawing inside the KiCad library (eSim\_Nghdl.lib) of the VHDL block to be used in mixed-signal simulations. An acknowledgement message will appear upon sucessful processing of the VHDL code as shown in \figref{upload}. \\
 
         \begin{figure}[!htp]
             \centering
diff --git a/cover_page.tex b/cover_page.tex
index 658cf64e..ad74b330 100644
--- a/cover_page.tex
+++ b/cover_page.tex
@@ -7,7 +7,7 @@
 \vfill
 \LARGE \textbf{eSim User Manual} \\ 
 %\vfill
-\small{version 2.0}\\
+\small{version 2.1}\\
 \vspace{1cm}
 \textbf{Prepared By:}\\
 eSim Team\\
@@ -17,7 +17,7 @@ FOSSEE at IIT, Bombay
 \includegraphics[width=0.2\linewidth]{iitblogo.png} \\
 Indian Institute of Technology Bombay \\ [2mm]
 {\LARGE \byncnd} \\ [1mm]
-March 2020
+August 2020
 \end{center}
 % \clearpage
 
diff --git a/esim_1_1.tex b/esim_1_1.tex
index ed7cc819..072c36c0 100644
--- a/esim_1_1.tex
+++ b/esim_1_1.tex
@@ -4,9 +4,9 @@
 %%
 %%    Description:  
 %%
-%%        Version:  2.0
+%%        Version:  2.1
 %%        Created:  Mar 2020
-%%       Revision:  none
+%%       Revision:  Aug 2020
 %%
 %%         Author:  
 %%   Organization:  eSim,FOSSEE
diff --git a/main.tex b/main.tex
index 9d2db322..56cde2dd 100644
--- a/main.tex
+++ b/main.tex
@@ -4,9 +4,9 @@
 %%
 %%    Description:  
 %%
-%%        Version:  2.0.0
+%%        Version:  2.1.0
 %%        Created:  March 2020
-%%       Revision:  none
+%%       Revision:  August 2020
 %%
 %%         Author:  
 %%   Organization:  eSim,FOSSEE
@@ -32,6 +32,15 @@
 \usepackage{graphicx}%---added now---%
 \graphicspath{ {figures/} }%----added now---%
 %\usepackage{biblatex}
+\usepackage{color}   %May be necessary if you want to color links
+\usepackage{hyperref}
+\hypersetup{
+    colorlinks=true, %set true if you want colored links
+    linktoc=all,     %set to all if you want both sections and subsections linked
+    linkcolor=blue,  %choose some color if you want links to stand out
+    urlcolor=blue
+}
+\usepackage{multicol}
 \newcommand{\ourname}[1]{\\ [1.5mm] \noindent{\bf #1}}
 % Shroff book size
 \textheight 7.75in
@@ -102,6 +111,8 @@
 %\newpage
 \cleardoublepage
 
+\input{acknowledgement.tex} %adds acknowledgement
+
 \pagenumbering{arabic} %reset numbering to normal for the main content
 \input{introduction_page.tex} % adds the chapter 1 introduction
 \input{chap_2.tex} % adds chapter 2