diff options
| -rw-r--r-- | eSim_CodeDocumentation.aux | 17 | ||||
| -rw-r--r-- | eSim_CodeDocumentation.log | 531 | ||||
| -rw-r--r-- | eSim_CodeDocumentation.pdf | bin | 0 -> 262375 bytes | |||
| -rw-r--r-- | eSim_CodeDocumentation.tex | 263 | ||||
| -rw-r--r-- | fossee-logo.png | bin | 0 -> 116801 bytes |
5 files changed, 811 insertions, 0 deletions
diff --git a/eSim_CodeDocumentation.aux b/eSim_CodeDocumentation.aux new file mode 100644 index 0000000..7ea34c7 --- /dev/null +++ b/eSim_CodeDocumentation.aux @@ -0,0 +1,17 @@ +\relax +\select@language{english} +\@writefile{toc}{\select@language{english}} +\@writefile{lof}{\select@language{english}} +\@writefile{lot}{\select@language{english}} +\@writefile{toc}{\contentsline {section}{\numberline {1}Prerequisite}{2}} +\@writefile{toc}{\contentsline {section}{\numberline {2}eSim installation}{3}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.1}Ubuntu}{3}} +\@writefile{toc}{\contentsline {subsection}{\numberline {2.2}Windows}{3}} +\@writefile{toc}{\contentsline {section}{\numberline {3}eSim Modules}{4}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.1}frontEnd}{4}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.1}Application.py}{4}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.2}Workspace.py}{5}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.1.3}DockArea.py}{6}} +\@writefile{toc}{\contentsline {subsection}{\numberline {3.2}browser}{7}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.1}UserManual.py}{7}} +\@writefile{toc}{\contentsline {subsubsection}{\numberline {3.2.2}Welcome.py}{7}} diff --git a/eSim_CodeDocumentation.log b/eSim_CodeDocumentation.log new file mode 100644 index 0000000..c1183a0 --- /dev/null +++ b/eSim_CodeDocumentation.log @@ -0,0 +1,531 @@ +This is pdfTeX, Version 3.1415926-1.40.10 (TeX Live 2009/Debian) (format=pdflatex 2015.3.25) 4 NOV 2016 12:34 +entering extended mode + %&-line parsing enabled. +**eSim_CodeDocumentation.tex +(./eSim_CodeDocumentation.tex +LaTeX2e <2009/09/24> +Babel <v3.8l> and hyphenation patterns for english, usenglishmax, dumylang, noh +yphenation, loaded. +(/usr/share/texmf-texlive/tex/latex/base/article.cls +Document Class: article 2007/10/19 v1.4h Standard LaTeX document class +(/usr/share/texmf-texlive/tex/latex/base/size12.clo +File: size12.clo 2007/10/19 v1.4h Standard LaTeX file (size option) +) +\c@part=\count79 +\c@section=\count80 +\c@subsection=\count81 +\c@subsubsection=\count82 +\c@paragraph=\count83 +\c@subparagraph=\count84 +\c@figure=\count85 +\c@table=\count86 +\abovecaptionskip=\skip41 +\belowcaptionskip=\skip42 +\bibindent=\dimen102 +) +(/usr/share/texmf-texlive/tex/generic/babel/babel.sty +Package: babel 2008/07/06 v3.8l The Babel package + +(/usr/share/texmf-texlive/tex/generic/babel/english.ldf +Language: english 2005/03/30 v3.3o English support from the babel system + +(/usr/share/texmf-texlive/tex/generic/babel/babel.def +File: babel.def 2008/07/06 v3.8l Babel common definitions +\babel@savecnt=\count87 +\U@D=\dimen103 +) +\l@british = a dialect from \language\l@english +\l@UKenglish = a dialect from \language\l@english +\l@canadian = a dialect from \language\l@american +\l@australian = a dialect from \language\l@british +\l@newzealand = a dialect from \language\l@british +)) +(/usr/share/texmf-texlive/tex/latex/base/inputenc.sty +Package: inputenc 2008/03/30 v1.1d Input encoding file +\inpenc@prehook=\toks14 +\inpenc@posthook=\toks15 + +(/usr/share/texmf-texlive/tex/latex/ucs/utf8x.def +File: utf8x.def 2004/10/17 UCS: Input encoding UTF-8 +)) +(/usr/share/texmf-texlive/tex/latex/ucs/ucs.sty +Package: ucs 2004/10/17 UCS: Unicode input support + +(/usr/share/texmf-texlive/tex/latex/ucs/data/uni-global.def +File: uni-global.def 2004/10/17 UCS: Unicode global data +) +\uc@secondtry=\count88 +\uc@combtoks=\toks16 +\uc@combtoksb=\toks17 +\uc@temptokena=\toks18 +) +(/usr/share/texmf-texlive/tex/latex/amsmath/amsmath.sty +Package: amsmath 2000/07/18 v2.13 AMS math features +\@mathmargin=\skip43 + +For additional information on amsmath, use the `?' option. +(/usr/share/texmf-texlive/tex/latex/amsmath/amstext.sty +Package: amstext 2000/06/29 v2.01 + +(/usr/share/texmf-texlive/tex/latex/amsmath/amsgen.sty +File: amsgen.sty 1999/11/30 v2.0 +\@emptytoks=\toks19 +\ex@=\dimen104 +)) +(/usr/share/texmf-texlive/tex/latex/amsmath/amsbsy.sty +Package: amsbsy 1999/11/29 v1.2d +\pmbraise@=\dimen105 +) +(/usr/share/texmf-texlive/tex/latex/amsmath/amsopn.sty +Package: amsopn 1999/12/14 v2.01 operator names +) +\inf@bad=\count89 +LaTeX Info: Redefining \frac on input line 211. +\uproot@=\count90 +\leftroot@=\count91 +LaTeX Info: Redefining \overline on input line 307. +\classnum@=\count92 +\DOTSCASE@=\count93 +LaTeX Info: Redefining \ldots on input line 379. +LaTeX Info: Redefining \dots on input line 382. +LaTeX Info: Redefining \cdots on input line 467. +\Mathstrutbox@=\box26 +\strutbox@=\box27 +\big@size=\dimen106 +LaTeX Font Info: Redeclaring font encoding OML on input line 567. +LaTeX Font Info: Redeclaring font encoding OMS on input line 568. +\macc@depth=\count94 +\c@MaxMatrixCols=\count95 +\dotsspace@=\muskip10 +\c@parentequation=\count96 +\dspbrk@lvl=\count97 +\tag@help=\toks20 +\row@=\count98 +\column@=\count99 +\maxfields@=\count100 +\andhelp@=\toks21 +\eqnshift@=\dimen107 +\alignsep@=\dimen108 +\tagshift@=\dimen109 +\tagwidth@=\dimen110 +\totwidth@=\dimen111 +\lineht@=\dimen112 +\@envbody=\toks22 +\multlinegap=\skip44 +\multlinetaggap=\skip45 +\mathdisplay@stack=\toks23 +LaTeX Info: Redefining \[ on input line 2666. +LaTeX Info: Redefining \] on input line 2667. +) +(/usr/share/texmf-texlive/tex/latex/graphics/graphicx.sty +Package: graphicx 1999/02/16 v1.0f Enhanced LaTeX Graphics (DPC,SPQR) + +(/usr/share/texmf-texlive/tex/latex/graphics/keyval.sty +Package: keyval 1999/03/16 v1.13 key=value parser (DPC) +\KV@toks@=\toks24 +) +(/usr/share/texmf-texlive/tex/latex/graphics/graphics.sty +Package: graphics 2009/02/05 v1.0o Standard LaTeX Graphics (DPC,SPQR) + +(/usr/share/texmf-texlive/tex/latex/graphics/trig.sty +Package: trig 1999/03/16 v1.09 sin cos tan (DPC) +) +(/etc/texmf/tex/latex/config/graphics.cfg +File: graphics.cfg 2009/08/28 v1.8 graphics configuration of TeX Live +) +Package graphics Info: Driver file: pdftex.def on input line 91. + +(/usr/share/texmf-texlive/tex/latex/pdftex-def/pdftex.def +File: pdftex.def 2010/03/12 v0.04p Graphics/color for pdfTeX +\Gread@gobject=\count101 +)) +\Gin@req@height=\dimen113 +\Gin@req@width=\dimen114 +) +(/usr/share/texmf-texlive/tex/latex/todonotes/todonotes.sty +Package: todonotes 2009/08/01 .dtx Todonotes source and documentation. +Package: todonotes 2009/04/02 + +(/usr/share/texmf-texlive/tex/latex/base/ifthen.sty +Package: ifthen 2001/05/26 v1.1c Standard LaTeX ifthen package (DPC) +) +(/usr/share/texmf-texlive/tex/latex/xkeyval/xkeyval.sty +Package: xkeyval 2008/08/13 v2.6a package option processing (HA) + +(/usr/share/texmf-texlive/tex/generic/xkeyval/xkeyval.tex +\XKV@toks=\toks25 +\XKV@tempa@toks=\toks26 +\XKV@depth=\count102 +File: xkeyval.tex 2008/08/13 v2.6a key=value parser (HA) +)) +(/usr/share/texmf/tex/latex/xcolor/xcolor.sty +Package: xcolor 2007/01/21 v2.11 LaTeX color extensions (UK) + +(/etc/texmf/tex/latex/config/color.cfg +File: color.cfg 2007/01/18 v1.5 color configuration of teTeX/TeXLive +) +Package xcolor Info: Driver file: pdftex.def on input line 225. +Package xcolor Info: Model `cmy' substituted by `cmy0' on input line 1337. +Package xcolor Info: Model `hsb' substituted by `rgb' on input line 1341. +Package xcolor Info: Model `RGB' extended on input line 1353. +Package xcolor Info: Model `HTML' substituted by `rgb' on input line 1355. +Package xcolor Info: Model `Hsb' substituted by `hsb' on input line 1356. +Package xcolor Info: Model `tHsb' substituted by `hsb' on input line 1357. +Package xcolor Info: Model `HSB' substituted by `hsb' on input line 1358. +Package xcolor Info: Model `Gray' substituted by `gray' on input line 1359. +Package xcolor Info: Model `wave' substituted by `hsb' on input line 1360. +) +(/usr/share/texmf/tex/latex/pgf/frontendlayer/tikz.sty +(/usr/share/texmf/tex/latex/pgf/basiclayer/pgf.sty +(/usr/share/texmf/tex/latex/pgf/utilities/pgfrcs.sty +(/usr/share/texmf/tex/generic/pgf/utilities/pgfutil-common.tex +\pgfutil@everybye=\toks27 +) +(/usr/share/texmf/tex/generic/pgf/utilities/pgfutil-latex.def +\pgfutil@abb=\box28 + +(/usr/share/texmf-texlive/tex/latex/ms/everyshi.sty +Package: everyshi 2001/05/15 v3.00 EveryShipout Package (MS) +)) +(/usr/share/texmf/tex/generic/pgf/utilities/pgfrcs.code.tex +Package: pgfrcs 2010/10/25 v2.10 (rcs-revision 1.24) +)) +Package: pgf 2008/01/15 v2.10 (rcs-revision 1.12) + +(/usr/share/texmf/tex/latex/pgf/basiclayer/pgfcore.sty +(/usr/share/texmf/tex/latex/pgf/systemlayer/pgfsys.sty +(/usr/share/texmf/tex/generic/pgf/systemlayer/pgfsys.code.tex +Package: pgfsys 2010/06/30 v2.10 (rcs-revision 1.37) + +(/usr/share/texmf/tex/generic/pgf/utilities/pgfkeys.code.tex +\pgfkeys@pathtoks=\toks28 +\pgfkeys@temptoks=\toks29 + +(/usr/share/texmf/tex/generic/pgf/utilities/pgfkeysfiltered.code.tex +\pgfkeys@tmptoks=\toks30 +)) +\pgf@x=\dimen115 +\pgf@y=\dimen116 +\pgf@xa=\dimen117 +\pgf@ya=\dimen118 +\pgf@xb=\dimen119 +\pgf@yb=\dimen120 +\pgf@xc=\dimen121 +\pgf@yc=\dimen122 +\w@pgf@writea=\write3 +\r@pgf@reada=\read1 +\c@pgf@counta=\count103 +\c@pgf@countb=\count104 +\c@pgf@countc=\count105 +\c@pgf@countd=\count106 + +(/usr/share/texmf/tex/generic/pgf/systemlayer/pgf.cfg +File: pgf.cfg 2008/05/14 (rcs-revision 1.7) +) +Package pgfsys Info: Driver file for pgf: pgfsys-pdftex.def on input line 900. + +(/usr/share/texmf/tex/generic/pgf/systemlayer/pgfsys-pdftex.def +File: pgfsys-pdftex.def 2009/05/22 (rcs-revision 1.26) + +(/usr/share/texmf/tex/generic/pgf/systemlayer/pgfsys-common-pdf.def +File: pgfsys-common-pdf.def 2008/05/19 (rcs-revision 1.10) +))) +(/usr/share/texmf/tex/generic/pgf/systemlayer/pgfsyssoftpath.code.tex +File: pgfsyssoftpath.code.tex 2008/07/18 (rcs-revision 1.7) +\pgfsyssoftpath@smallbuffer@items=\count107 +\pgfsyssoftpath@bigbuffer@items=\count108 +) +(/usr/share/texmf/tex/generic/pgf/systemlayer/pgfsysprotocol.code.tex +File: pgfsysprotocol.code.tex 2006/10/16 (rcs-revision 1.4) +)) +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcore.code.tex +Package: pgfcore 2010/04/11 v2.10 (rcs-revision 1.7) + +(/usr/share/texmf/tex/generic/pgf/math/pgfmath.code.tex +(/usr/share/texmf/tex/generic/pgf/math/pgfmathcalc.code.tex +(/usr/share/texmf/tex/generic/pgf/math/pgfmathutil.code.tex) +(/usr/share/texmf/tex/generic/pgf/math/pgfmathparser.code.tex +\pgfmath@dimen=\dimen123 +\pgfmath@count=\count109 +\pgfmath@box=\box29 +\pgfmath@toks=\toks31 +\pgfmath@stack@operand=\toks32 +\pgfmath@stack@operation=\toks33 +) +(/usr/share/texmf/tex/generic/pgf/math/pgfmathfunctions.code.tex +(/usr/share/texmf/tex/generic/pgf/math/pgfmathfunctions.basic.code.tex) +(/usr/share/texmf/tex/generic/pgf/math/pgfmathfunctions.trigonometric.code.tex) +(/usr/share/texmf/tex/generic/pgf/math/pgfmathfunctions.random.code.tex) +(/usr/share/texmf/tex/generic/pgf/math/pgfmathfunctions.comparison.code.tex) +(/usr/share/texmf/tex/generic/pgf/math/pgfmathfunctions.base.code.tex) +(/usr/share/texmf/tex/generic/pgf/math/pgfmathfunctions.round.code.tex) +(/usr/share/texmf/tex/generic/pgf/math/pgfmathfunctions.misc.code.tex))) +(/usr/share/texmf/tex/generic/pgf/math/pgfmathfloat.code.tex +\c@pgfmathroundto@lastzeros=\count110 +)) +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcorepoints.code.tex +File: pgfcorepoints.code.tex 2010/04/09 (rcs-revision 1.20) +\pgf@picminx=\dimen124 +\pgf@picmaxx=\dimen125 +\pgf@picminy=\dimen126 +\pgf@picmaxy=\dimen127 +\pgf@pathminx=\dimen128 +\pgf@pathmaxx=\dimen129 +\pgf@pathminy=\dimen130 +\pgf@pathmaxy=\dimen131 +\pgf@xx=\dimen132 +\pgf@xy=\dimen133 +\pgf@yx=\dimen134 +\pgf@yy=\dimen135 +\pgf@zx=\dimen136 +\pgf@zy=\dimen137 +) +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcorepathconstruct.code.tex +File: pgfcorepathconstruct.code.tex 2010/08/03 (rcs-revision 1.24) +\pgf@path@lastx=\dimen138 +\pgf@path@lasty=\dimen139 +) +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcorepathusage.code.tex +File: pgfcorepathusage.code.tex 2008/04/22 (rcs-revision 1.12) +\pgf@shorten@end@additional=\dimen140 +\pgf@shorten@start@additional=\dimen141 +) +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcorescopes.code.tex +File: pgfcorescopes.code.tex 2010/09/08 (rcs-revision 1.34) +\pgfpic=\box30 +\pgf@hbox=\box31 +\pgf@layerbox@main=\box32 +\pgf@picture@serial@count=\count111 +) +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcoregraphicstate.code.tex +File: pgfcoregraphicstate.code.tex 2008/04/22 (rcs-revision 1.9) +\pgflinewidth=\dimen142 +) +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcoretransformations.code.tex +File: pgfcoretransformations.code.tex 2009/06/10 (rcs-revision 1.11) +\pgf@pt@x=\dimen143 +\pgf@pt@y=\dimen144 +\pgf@pt@temp=\dimen145 +) +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcorequick.code.tex +File: pgfcorequick.code.tex 2008/10/09 (rcs-revision 1.3) +) +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcoreobjects.code.tex +File: pgfcoreobjects.code.tex 2006/10/11 (rcs-revision 1.2) +) +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcorepathprocessing.code.tex +File: pgfcorepathprocessing.code.tex 2008/10/09 (rcs-revision 1.8) +) +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcorearrows.code.tex +File: pgfcorearrows.code.tex 2008/04/23 (rcs-revision 1.11) +) +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcoreshade.code.tex +File: pgfcoreshade.code.tex 2008/11/23 (rcs-revision 1.13) +\pgf@max=\dimen146 +\pgf@sys@shading@range@num=\count112 +) +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcoreimage.code.tex +File: pgfcoreimage.code.tex 2010/03/25 (rcs-revision 1.16) + +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcoreexternal.code.tex +File: pgfcoreexternal.code.tex 2010/09/01 (rcs-revision 1.17) +\pgfexternal@startupbox=\box33 +)) +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcorelayers.code.tex +File: pgfcorelayers.code.tex 2010/08/27 (rcs-revision 1.2) +) +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcoretransparency.code.tex +File: pgfcoretransparency.code.tex 2008/01/17 (rcs-revision 1.2) +) +(/usr/share/texmf/tex/generic/pgf/basiclayer/pgfcorepatterns.code.tex +File: pgfcorepatterns.code.tex 2009/07/02 (rcs-revision 1.3) +))) +(/usr/share/texmf/tex/generic/pgf/modules/pgfmoduleshapes.code.tex +File: pgfmoduleshapes.code.tex 2010/09/09 (rcs-revision 1.13) +\pgfnodeparttextbox=\box34 +) +(/usr/share/texmf/tex/generic/pgf/modules/pgfmoduleplot.code.tex +File: pgfmoduleplot.code.tex 2010/10/22 (rcs-revision 1.8) +) +(/usr/share/texmf/tex/latex/pgf/compatibility/pgfcomp-version-0-65.sty +Package: pgfcomp-version-0-65 2007/07/03 v2.10 (rcs-revision 1.7) +\pgf@nodesepstart=\dimen147 +\pgf@nodesepend=\dimen148 +) +(/usr/share/texmf/tex/latex/pgf/compatibility/pgfcomp-version-1-18.sty +Package: pgfcomp-version-1-18 2007/07/23 v2.10 (rcs-revision 1.1) +)) +(/usr/share/texmf/tex/latex/pgf/utilities/pgffor.sty +(/usr/share/texmf/tex/latex/pgf/utilities/pgfkeys.sty +(/usr/share/texmf/tex/generic/pgf/utilities/pgfkeys.code.tex)) +(/usr/share/texmf/tex/generic/pgf/utilities/pgffor.code.tex +Package: pgffor 2010/03/23 v2.10 (rcs-revision 1.18) +\pgffor@iter=\dimen149 +\pgffor@skip=\dimen150 +\pgffor@stack=\toks34 +\pgffor@toks=\toks35 +)) +(/usr/share/texmf/tex/generic/pgf/frontendlayer/tikz/tikz.code.tex +Package: tikz 2010/10/13 v2.10 (rcs-revision 1.76) + +(/usr/share/texmf/tex/generic/pgf/libraries/pgflibraryplothandlers.code.tex +File: pgflibraryplothandlers.code.tex 2010/05/31 v2.10 (rcs-revision 1.15) +\pgf@plot@mark@count=\count113 +\pgfplotmarksize=\dimen151 +) +\tikz@lastx=\dimen152 +\tikz@lasty=\dimen153 +\tikz@lastxsaved=\dimen154 +\tikz@lastysaved=\dimen155 +\tikzleveldistance=\dimen156 +\tikzsiblingdistance=\dimen157 +\tikz@figbox=\box35 +\tikz@tempbox=\box36 +\tikztreelevel=\count114 +\tikznumberofchildren=\count115 +\tikznumberofcurrentchild=\count116 +\tikz@fig@count=\count117 + +(/usr/share/texmf/tex/generic/pgf/modules/pgfmodulematrix.code.tex +File: pgfmodulematrix.code.tex 2010/08/24 (rcs-revision 1.4) +\pgfmatrixcurrentrow=\count118 +\pgfmatrixcurrentcolumn=\count119 +\pgf@matrix@numberofcolumns=\count120 +) +\tikz@expandcount=\count121 + +(/usr/share/texmf/tex/generic/pgf/frontendlayer/tikz/libraries/tikzlibrarytopat +hs.code.tex +File: tikzlibrarytopaths.code.tex 2008/06/17 v2.10 (rcs-revision 1.2) +))) (/usr/share/texmf-texlive/tex/latex/tools/calc.sty +Package: calc 2007/08/22 v4.3 Infix arithmetic (KKT,FJ) +\calc@Acount=\count122 +\calc@Bcount=\count123 +\calc@Adimen=\dimen158 +\calc@Bdimen=\dimen159 +\calc@Askip=\skip46 +\calc@Bskip=\skip47 +LaTeX Info: Redefining \setlength on input line 76. +LaTeX Info: Redefining \addtolength on input line 77. +\calc@Ccount=\count124 +\calc@Cskip=\skip48 +) +\c@@todonotes@numberoftodonotes=\count125 +) +(/usr/share/texmf-texlive/tex/latex/listings/listings.sty +\lst@mode=\count126 +\lst@gtempboxa=\box37 +\lst@token=\toks36 +\lst@length=\count127 +\lst@currlwidth=\dimen160 +\lst@column=\count128 +\lst@pos=\count129 +\lst@lostspace=\dimen161 +\lst@width=\dimen162 +\lst@newlines=\count130 +\lst@lineno=\count131 +\lst@maxwidth=\dimen163 + +(/usr/share/texmf-texlive/tex/latex/listings/lstmisc.sty +File: lstmisc.sty 2007/02/22 1.4 (Carsten Heinz) +\c@lstnumber=\count132 +\lst@skipnumbers=\count133 +\lst@framebox=\box38 +) +(/usr/share/texmf-texlive/tex/latex/listings/listings.cfg +File: listings.cfg 2007/02/22 1.4 listings configuration +)) +Package: listings 2007/02/22 1.4 (Carsten Heinz) + +(/usr/share/texmf-texlive/tex/latex/listings/lstlang1.sty +File: lstlang1.sty 2004/09/05 1.3 listings language file +) +(/usr/share/texmf-texlive/tex/latex/listings/lstlang1.sty +File: lstlang1.sty 2004/09/05 1.3 listings language file +) +(./eSim_CodeDocumentation.aux) +\openout1 = `eSim_CodeDocumentation.aux'. + +LaTeX Font Info: Checking defaults for OML/cmm/m/it on input line 36. +LaTeX Font Info: ... okay on input line 36. +LaTeX Font Info: Checking defaults for T1/cmr/m/n on input line 36. +LaTeX Font Info: ... okay on input line 36. +LaTeX Font Info: Checking defaults for OT1/cmr/m/n on input line 36. +LaTeX Font Info: ... okay on input line 36. +LaTeX Font Info: Checking defaults for OMS/cmsy/m/n on input line 36. +LaTeX Font Info: ... okay on input line 36. +LaTeX Font Info: Checking defaults for OMX/cmex/m/n on input line 36. +LaTeX Font Info: ... okay on input line 36. +LaTeX Font Info: Checking defaults for U/cmr/m/n on input line 36. +LaTeX Font Info: ... okay on input line 36. + +(/usr/share/texmf-texlive/tex/latex/ucs/ucsencs.def +File: ucsencs.def 2003/11/29 Fixes to fontencodings LGR, T3 +) +(/usr/share/texmf-texlive/tex/context/base/supp-pdf.mkii +[Loading MPS to PDF converter (version 2006.09.02).] +\scratchcounter=\count134 +\scratchdimen=\dimen164 +\scratchbox=\box39 +\nofMPsegments=\count135 +\nofMParguments=\count136 +\everyMPshowfont=\toks37 +\MPscratchCnt=\count137 +\MPscratchDim=\dimen165 +\MPnumerator=\count138 +\everyMPtoPDFconversion=\toks38 +) ABD: EveryShipout initializing macros +\c@lstlisting=\count139 + +<fossee-logo.png, id=4, 145.0234pt x 55.3506pt> +File: fossee-logo.png Graphic file (type png) + <use fossee-logo.png> [1 + +{/var/lib/texmf/fonts/map/pdftex/updmap/pdftex.map} <./fossee-logo.png>] +Overfull \hbox (25.50694pt too wide) in paragraph at lines 81--82 +\OT1/cmr/m/n/10.95 (http://www.kicad-pcb.org) and Ngspice (http://ngspice.sourc +eforge.net/). + [] + +[1] +LaTeX Font Info: Try loading font information for OMS+cmr on input line 96. + (/usr/share/texmf-texlive/tex/latex/base/omscmr.fd +File: omscmr.fd 1999/05/25 v2.5h Standard LaTeX font definitions +) +LaTeX Font Info: Font shape `OMS/cmr/m/n' in size <12> not available +(Font) Font shape `OMS/cmsy/m/n' tried instead on input line 96. + [2] +Overfull \hbox (3.94315pt too wide) in paragraph at lines 134--139 +[]\OT1/cmr/m/n/12 Download eSim in-staller for Linux from http://esim.fossee.in +/downloads + [] + + +Overfull \hbox (41.44691pt too wide) in paragraph at lines 163--164 +[]\OT1/cmr/m/n/12 Download eSim win-dows in-staller from web-site http://esim.f +ossee.in/downloads + [] + +[3] [4] [5] [6] [7] (./eSim_CodeDocumentation.aux) ) +Here is how much of TeX's memory you used: + 12527 strings out of 495061 + 221450 string characters out of 1182621 + 302213 words of memory out of 3000000 + 15479 multiletter control sequences out of 15000+50000 + 7442 words of font info for 27 fonts, out of 3000000 for 9000 + 28 hyphenation exceptions out of 8191 + 63i,5n,97p,434b,1189s stack positions out of 5000i,500n,10000p,200000b,50000s +</usr/share/texmf-texlive/f +onts/type1/public/amsfonts/cm/cmbx10.pfb></usr/share/texmf-texlive/fonts/type1/ +public/amsfonts/cm/cmbx12.pfb></usr/share/texmf-texlive/fonts/type1/public/amsf +onts/cm/cmr10.pfb></usr/share/texmf-texlive/fonts/type1/public/amsfonts/cm/cmr1 +2.pfb></usr/share/texmf-texlive/fonts/type1/public/amsfonts/cm/cmr17.pfb></usr/ +share/texmf-texlive/fonts/type1/public/amsfonts/cm/cmsy10.pfb></usr/share/texmf +-texlive/fonts/type1/public/amsfonts/cm/cmti12.pfb></usr/share/texmf-texlive/fo +nts/type1/public/amsfonts/cm/cmtt10.pfb> +Output written on eSim_CodeDocumentation.pdf (8 pages, 262375 bytes). +PDF statistics: + 67 PDF objects out of 1000 (max. 8388607) + 0 named destinations out of 1000 (max. 500000) + 18 words of extra memory for PDF output out of 10000 (max. 10000000) + diff --git a/eSim_CodeDocumentation.pdf b/eSim_CodeDocumentation.pdf Binary files differnew file mode 100644 index 0000000..361f62c --- /dev/null +++ b/eSim_CodeDocumentation.pdf diff --git a/eSim_CodeDocumentation.tex b/eSim_CodeDocumentation.tex new file mode 100644 index 0000000..f771378 --- /dev/null +++ b/eSim_CodeDocumentation.tex @@ -0,0 +1,263 @@ + +\documentclass[12pt]{article} +\usepackage[english]{babel} +\usepackage[utf8x]{inputenc} +\usepackage{amsmath} +\usepackage{graphicx} +\usepackage[colorinlistoftodos]{todonotes} + +%Settings for Code block +\usepackage{listings} +\usepackage{color} + +\definecolor{dkgreen}{rgb}{0,0.6,0} +\definecolor{gray}{rgb}{0.5,0.5,0.5} +\definecolor{mauve}{rgb}{0.58,0,0.82} + +\lstset{frame=tb, + language=bash, + aboveskip=3mm, + belowskip=3mm, + showstringspaces=false, + columns=flexible, + basicstyle={\small\ttfamily}, + numbers=none, + numberstyle=\tiny\color{gray}, + keywordstyle=\color{blue}, + commentstyle=\color{dkgreen}, + stringstyle=\color{mauve}, + breaklines=true, + breakatwhitespace=true, + tabsize=3 +} +% Code block setting ends + + +\begin{document} +\begin{titlepage} + + + + +\newcommand{\HRule}{\rule{\linewidth}{0.5mm}} % Defines a new command for the horizontal lines, change thickness here + +\center % Center everything on the page + +%---------------------------------------------------------------------------------------- +% TITLE SECTION +%---------------------------------------------------------------------------------------- + +\HRule \\[0.4cm] +{ \huge \bfseries eSim code documentation}\\[0.4cm] % Title of your document +{\small v1.1.2} +\HRule \\[1.5cm] + +%---------------------------------------------------------------------------------------- +% AUTHOR SECTION +%---------------------------------------------------------------------------------------- + +\Large \emph{Author:}\\ +Fahim Khan\\[3cm] % Your name + +%---------------------------------------------------------------------------------------- +% DATE SECTION +%---------------------------------------------------------------------------------------- + +{\large \today}\\[2cm] % Date, change the \today to a set date if you want to be precise + +%---------------------------------------------------------------------------------------- +% LOGO SECTION +%---------------------------------------------------------------------------------------- + +\includegraphics{fossee-logo.png}\\[1cm] % Include a department/university logo - this will require the graphicx package + +%---------------------------------------------------------------------------------------- + +\vfill % Fill the rest of the page with whitespace + +\end{titlepage} + +\begin{abstract} +eSim (previously known as Oscad / FreeEDA) is an open source EDA tool for circuit design, simulation, analysis and PCB design. It is an integrated tool built using open source software such as KiCad (http://www.kicad-pcb.org) and Ngspice (http://ngspice.sourceforge.net/). eSim is released under GPL. + +eSim offers similar capabilities and ease of use as any equivalent proprietary software for schematic creation, simulation and PCB design, without having to pay a huge amount of money to procure licenses. Hence it can be an affordable alternative to educational institutions and SMEs. It can serve as an alternative to commercially available/ licensed software tools like OrCAD, Xpedition and HSPICE.. +\end{abstract} + +\newpage +% \pagebreak + +\section{Prerequisite} + +eSim has following dependency. + +\begin{enumerate} + \item Software Package + \begin{itemize} + \item Python 2.7 + \item PyQt4 + \item Matplotlib + \item numpy + \end{itemize} + + \item Open source tool + \begin{itemize} + \item Python 2.7 + \item PyQt4 + \item Matplotlib + \item numpy + \end{itemize} +\end{enumerate} + +% \begin{table}[htb] +% \centering +% % \begin{tabular}{l|r} +% % Package & Version \\\hline +% % Node JS & 6.0.0 \\ +% % Python & 2.7 \\ +% % ngspice & 26 or 27 \\ +% % pm2 & 1.1.3 +% % \end{tabular} +% \caption{\label{tab:widgets}Package Details} +% \end{table} + +% The eSim web application can be run with Node JS 5.x.x as well as 6.0.0. It is upto you which version you want to install. NgSpice can be installed from synaptic instead of compiling from source code. + +\newpage + +\section{eSim installation} + + eSim is available for Ubuntu and Windows(7,8,10). + +\subsection{Ubuntu} + \begin{enumerate} + + \item Download eSim installer for Linux from 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: + + \begin{lstlisting} + unzip eSim-1.1.2.zip + \end{lstlisting} + + \item To install eSim and other dependecies run the following command. + + \begin{lstlisting} + ../install-linux.sh --install + \end{lstlisting} + + \item Once the eSim is installed, you can open it from the terminal. + + \begin{lstlisting} + esim + \end{lstlisting} + + or you can double click on eSim icon created on the Desktop after installation. + + \end{enumerate} + + +\subsection{Windows} + \begin{enumerate} + \item Download eSim windows installer from website http://esim.fossee.in/downloads + \item Open eSim-Windows-Installer folder, right click on Setup file and select run + as administrator. Click Yes and Next to complete the installation. + \item eSim icon will be created on deskop. You can double click on the eSim icon + created on the Desktop after installation. + \end{enumerate} + + +\newpage + +\section{eSim Modules} + +eSim code is divied into modules based on the functionality. All modules are under `src` folder of eSim. + +To run eSim application from command line. Open command line intepreter and go to the location under src/frontend + +Now run the below command to open eSim window. + +\begin{lstlisting} + python Application.py +\end{lstlisting} + +\subsection{frontEnd} +This package contain main gui modules of eSim. All main window compoenet such as Project explorer,Dock area,workspace are present in this package. + +\subsubsection{Application.py} +This file contain main function. The main function initiate the Application class as well as instantiate workspace module where user can define the workspace location where all the project will be stored. + +\begin{itemize} + \item Class Application : This class is repponsible for initiating all the neccessary class. Also it creates the gui for tool bar and menu bar. The function details are as follows. + \begin{itemize} + \item initToolBar(): This initiate the tool bar. + \item closeEvent(event): This function close the event. Event can be any process or widget. + \item close\_project(): It close the project and clear all the variable which hold project information. + \item new\_project(): It creates new project in eSim and add the information in project explorer. If project is already open then it overwrite project related variable with new project information. + \item open\_project(): It open the project and add it to project explorer. + \item help\_project(): It open the eSim user manual. + + \item open\_ngspice(): It execute the ngspice netlist of current project. And also open the Python plotting window inside dock area. If the netlist is not present then it will throw an exception. + \item open\_subcircuit(): It open sub circuit widget inside the dock area. + + \item open\_nghdl(): It opens the nghdl widget where user can upload the nghdl model. Nghdl has to be installed before using it in eSim. You can install it independently as well as along with eSim installation. + \item open\_modelEditor(): It opens model editor widget in the dock area. + \item open\_OMedit(): This function call ngspice to OM edit converter and then launch OM edit provided OM edit is installed in the machine. OMEdit and OMOptim is part of Open modelica tool which needs to be installed separately. + \item open\_OMoptim(): This function open the OM Optim (optimization tool of Open Modellica) + \end{itemize} + + \item Class MainView : This class set the main view of window. It add note area, split the widget and complete the layout management for frontend. Also it initialze the DockArea and Project Explorer. +\end{itemize} + +\subsubsection{Workspace.py} + +This module create workspace window where user can browse to his/her desired workspace location. The default workspace location is in home directory. + +\begin{itemize} + \item Class Workspace : This create the workspace window which appear on the top of main window. + \begin{itemize} + \item initWorkspace(): This create gui of Workspace widget. + \item defaultWorkspace(): This function select default workspace location. + \item returnWhetherClickedOrNot(): It checked if it is clicked or not. + \item createWorkspace(): If press ok then it creats proper workspace location + \item browseLocation(): This function return the path/location which user has selected. + + \end{itemize} + +\end{itemize} + + +\subsubsection{DockArea.py} + +This module is responisble to create widget inside dock area. + +\begin{itemize} + \item Class DockArea : Responsible for instantiating the dock widget. + \begin{itemize} + \item createTestEditor(): This function is for testing new widget inside dock area. + \item plottingEditor(): This function creates the python plotting widget inside dock area. + \item ngspiceEditor(): This function open the ngspice editor but not in dock area. + \item modelEditor(): This function create the model editor widget and instatiate the Model editor class. + \item kicadToNgspiceEditor(): This function create the kicad to ngspice converter widget. + \item subcircuiteditor(): This function create the widget for sub circuir. + \item usermanual(): This function create the widget for user manual. + \item modelicaEditor() : This function create the widget for Modellica Editor from where user can open OMEdit and OMOptim. + \item closeDock(): This function is called when any dock widget is closed. + + \end{itemize} + +\end{itemize} +\newpage + +\subsection{browser} +This package is responsible for openning user manual in browser. + +\subsubsection{UserManual.py} +This module open the user manual in web browser using python webbrowser package. + +\subsubsection{Welcome.py} +This module creates the eSim welcome page. + +\end{document} +
\ No newline at end of file diff --git a/fossee-logo.png b/fossee-logo.png Binary files differnew file mode 100644 index 0000000..f2476c8 --- /dev/null +++ b/fossee-logo.png |
