Merge pull request #190 from rahulp13/manualm2.2_pre-release

Updated manual for pre-release of v2.2

10 files changed, 49 insertions, 40 deletions

diff --git a/acknowledgement.tex b/acknowledgement.tex
index 50842c11..bbf3e1d5 100644
--- a/acknowledgement.tex
+++ b/acknowledgement.tex
@@ -9,14 +9,21 @@ There  have  been  many  people contributing towards the software development an
     \item Rahul Paknikar
     \item Saurabh Bansode
     \item Gloria Nandihal
+    \item Sumanto Kar
     \item Athul George
     \item Gaurav Supal
     \item Kayva Manohar
     \item Komal Sheth
 
 
+    \item Jay Mistry
+    \item Manasi Yadav
+    \item Digvijay Singh
+    \item Madhuri Kadam
+    \item Nalinkumar S
+    \item R.V.Rohinth Ram
+    \item Charaan S
     \item Ashutosh Jha
-    \item Sumanto Kar
     \item Shubhangi Mahajan
     \item Vadissa Yamini
     \item Bladen Martin
@@ -40,10 +47,10 @@ There  have  been  many  people contributing towards the software development an
 \end{itemize}
 \end{multicols}
 
-\subsection*{Technical Guidance}
-\begin{multicols}{2}
+\subsection*{Technical Guidance:}
+\begin{multicols}{3}
 \begin{itemize}
-    \item Kannan M. Moudgalya
+    \item Kannan Moudgalya
     \item Pramod Murali
     \item Madhav P. Desai
     \item Usha Vishwanathan
@@ -54,10 +61,11 @@ There  have  been  many  people contributing towards the software development an
 \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
+    \item NMEICT, MoE, Govt. Of India
+    \item MoE, 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.
+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 feel free to contact us at \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_12.tex b/chap_12.tex
index d1669481..df84884d 100644
--- a/chap_12.tex
+++ b/chap_12.tex
@@ -202,7 +202,7 @@ The layout editor with the various menu bar and toolbars is shown in
 
 \subsubsection{Top toolbar}
 Some of the important menu options in the top menu bar are shown in
-\figref{toptble}. They are explained below:
+\figref{pcbnew}. They are explained below:
 \begin{compactenum}
 \item Save board - Save the printed circuit board
 %\item Module editor - Open module editor to edit footprint modules or
diff --git a/chap_2.tex b/chap_2.tex
index 695d2fe6..2526f236 100644
--- a/chap_2.tex
+++ b/chap_2.tex
@@ -8,9 +8,9 @@ to design, test and analyse their circuits. But the important feature
 of this tool is that it is open source and hence the user can modify
 the source as per his/her need. The software provides a generic,
 modular and extensible platform for experiment with electronic
-circuits. This software runs on Ubuntu Linux distributions 14.04,16.04, 18.04 and 
-some flavours of Windows.  It uses {\tt Python 3}, {\tt KiCad 4.0.7},
-{\tt GHDL}
+circuits. This software runs on Ubuntu Linux LTS distributions 18.04 and 20.04 %some flavours of Windows.
+It uses {\tt Python 3}, {\tt KiCad 4.0.7},
+{\tt GHDL}, {\tt Verilator}
 and 
 {\tt Ngspice}.
 
diff --git a/chap_3.tex b/chap_3.tex
index 25b9ca43..36c936a8 100644
--- a/chap_3.tex
+++ b/chap_3.tex
@@ -4,25 +4,25 @@
 
 \section {eSim installation in Ubuntu OS}
 \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:
+\item Download eSim installer 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 the installer is located. Use the following command to unpack: \\
 \\
-\quad {\tt \$ unzip eSim-2.1.zip}
-\item To install eSim and other dependencies run the following command:
+\quad {\tt \$ unzip eSim-2.2\_pre-release.zip}
+\item To install eSim and other dependencies run the following command: \\
 \\
- \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 \$ cd eSim-2.2 \newline \$ chmod +x install-eSim.sh \newline \$ ./install-eSim.sh --install}
+\item To run eSim from the terminal, type: \\ 
 \\
-\quad {\tt \$ esim}
+\quad {\tt \$ esim} \\
 \\
-  or you can double click on {\tt eSim} icon created on the Desktop after installation.
+  or you can double click on {\tt eSim} icon created on Desktop after installation.
 \end{enumerate}
 
 
-\section {eSim installation in Windows OS}
-\begin{enumerate}
-\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.
-\end{enumerate}
+%\section {eSim installation in Windows OS}
+%\begin{enumerate}
+%\item Download \textbf{eSim-2.2\_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.
+%\end{enumerate}
 
diff --git a/chap_4.tex b/chap_4.tex
index 266c13d2..aded8ea2 100644
--- a/chap_4.tex
+++ b/chap_4.tex
@@ -120,10 +120,10 @@ It has the facility to select the
     \item The simulation parameter values for analysis
 \end{itemize}
 
-\item \texttt{Source Details:}eSim sources are added from {\tt eSim\_Sources} library in the schematic. Sources such as \textit{SINE, AC, DC, PULSE, PWL} are in this library. The parameter values to all the sources added in the schematic can 
+\item \texttt{Source Details:}eSim sources are added from {\tt eSim\_Sources} library in the \linebreak schematic. Sources such as \textit{SINE, AC, DC, PULSE, PWL} are in this library. The parameter values to all the sources added in the schematic can 
 be given through 'Source Details' tab in the KiCad-To-Ngspice window.
 
-\item \texttt{Ngspice Model:}Ngspice has in-built model such as \texttt{basic logic gates, flip-flops, gain, summer, buffer, DAC and ADC block}etc. which can be utilised while building a circuit.
+\item \texttt{Ngspice Model:}Ngspice has in-built model such as \texttt{basic logic gates, \linebreak flip-flops, gain, summer, buffer, DAC and ADC block}etc. which can be utilised while building a circuit.
 eSim allows to add and modify Ngspice model parameter through 
 Ngspice Model tab.
 
diff --git a/chap_6.tex b/chap_6.tex
index f0e98d09..073670a6 100644
--- a/chap_6.tex
+++ b/chap_6.tex
@@ -237,7 +237,7 @@ The component libraries for components like DAC, ADC, transformer etc. which are
 Spice based simulators include a feature which allows accurate modeling of semiconductor devices such as diodes, transistors etc. Model libraries holds these features to define models for devices such as diodes, MOSFET, BJT, JFET, IGBT, Magnetic core etc.
 
 The fields in this tab are added for each such device in the circuit and the corresponding model library is added. In the example of bridge rectifier as shown in \figref{bridgerectifier} for four diodes library files are added as in \figref{devicemodel}. Location for these libraries is as following : \\
-../Library/deviceModelLibrary/Diode/ if you are using version 2.0 and above \\
+../library/deviceModelLibrary/Diode/ if you are using version 2.0 and above \\
 ../src/deviceModelLibrary/Diode/ if you are using versions lower than 2.0
 
 \begin{figure}[h]
diff --git a/chap_7.tex b/chap_7.tex
index 9c7e8537..9d0297ac 100644
--- a/chap_7.tex
+++ b/chap_7.tex
@@ -75,4 +75,5 @@ User can also upload external spice {\textbf{.model}} library files. These .mode
 eSim provides the facility to upload library files using the {\textbf Upload} option in the {\textit 
 {Model Editor}}. They are then converted into xml format, which can be easily modified from the eSim interface.
 On clicking {\tt UPLOAD} button the library can be uploaded from any location. The model library will be saved with the name you have provided, in the \textit {User Libraries} folder of repository \textit{deviceModelLibrary}.
-Example: You can download any model of Schottky diode from Spice website and save it as .lib extension on the system. Click on  {\tt UPLOAD} option and give the path. The lib file along with XML file is created in the {\textitbf {\tt eSim-1.1.3/src/deviceModeLibrary/UserLibraries}}. The uploaded library can be used for the existing part eSim\_Diode or the user can create a new model(part). Refer Chapter 8 on how to create a new part library model in eSim.
+Example: You can download any model of Schottky diode from Spice website and save it as .lib extension on the system. Click on  {\tt UPLOAD} option and give the path. The lib file along with XML file is created in the {\tt eSim-2.0/library/deviceModeLibrary/UserLibraries if you are using v2.0 \linebreak and above versions \\
+ eSim-1.1.3/src/deviceModeLibrary/UserLibraries if you are using \linebreak versions lower than 2.0 \\}. The uploaded library can be used for the existing part eSim\_Diode or the user can create a new model (part). Refer Chapter 8 on how to create a new part library model in eSim.
diff --git a/chap_9.tex b/chap_9.tex
index e0b0f0ea..e5085088 100644
--- a/chap_9.tex
+++ b/chap_9.tex
@@ -1,9 +1,9 @@
-\chapter{NGHDL-Mixed Signal Simulation}
+\chapter{NGHDL: Mixed Signal Simulation}
 \label{chap9}
 \thispagestyle{empty}
 
 
-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. \\
+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. \\
 
 
 %To access NGHDL click on the NGHDL button on the left pane of window as shown in figure \figref{screen3}:
diff --git a/cover_page.tex b/cover_page.tex
index ad74b330..71d87e88 100644
--- a/cover_page.tex
+++ b/cover_page.tex
@@ -7,17 +7,17 @@
 \vfill
 \LARGE \textbf{eSim User Manual} \\ 
 %\vfill
-\small{version 2.1}\\
+\small{Version 2.2 (\textbf{\textit{Pre-release}})}\\
 \vspace{1cm}
 \textbf{Prepared By:}\\
 eSim Team\\
-FOSSEE at IIT, Bombay
+FOSSEE, IIT Bombay
 
 \vspace{1cm}
 \includegraphics[width=0.2\linewidth]{iitblogo.png} \\
 Indian Institute of Technology Bombay \\ [2mm]
 {\LARGE \byncnd} \\ [1mm]
-August 2020
+January 2022
 \end{center}
 % \clearpage
 
diff --git a/main.tex b/main.tex
index 56cde2dd..569423a9 100644
--- a/main.tex
+++ b/main.tex
@@ -4,13 +4,13 @@
 %%
 %%    Description:  
 %%
-%%        Version:  2.1.0
-%%        Created:  March 2020
-%%       Revision:  August 2020
+%%        Version:  2.2.0
+%%        Created:  November 2021
+%%       Revision:  January 2022
 %%
 %%         Author:  
-%%   Organization:  eSim,FOSSEE
-%%      Copyright:  Copyright (c) 2020, eSim
+%%   Organization:  eSim, FOSSEE
+%%      Copyright:  Copyright (c) 2022, eSim
 %%
 %%          Notes:  
 %%