trunk/doc/elist.tex


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
% Copyright (c) 2003-2018 by The University of Queensland
% http://www.uq.edu.au
%
% Primary Business: Queensland, Australia
% Licensed under the Apache License, version 2.0
% http://www.apache.org/licenses/LICENSE-2.0
%
% Development until 2012 by Earth Systems Science Computational Center (ESSCC)
% Development 2012-2013 by School of Earth Sciences
% Development from 2014 by Centre for Geoscience Computing (GeoComp)
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\usepackage{listing}
% defines the colour for the background of code examples
\definecolor{LightGrey}{gray}{0.9}

%Some colour definitions added to keep pdflatex happy
%I make no claim that these values are particularly good
\definecolor{Purple}{rgb}{0.7, 0, 0.6}
\definecolor{Tan}{rgb}{0.5,0.5,0.5}
\definecolor{BrickRed}{rgb}{0.7, 0.2, 0.2}
\definecolor{Black}{rgb}{0, 0, 0}

% All the \color{x} used to be \color[named]{x}
%end color defs

\lstdefinestyle{myC++}{%
language=C++,
showstringspaces=false,
basicstyle=\small\ttfamily,
commentstyle=\color{BrickRed}\ttfamily,
keywordstyle=\color{Purple}\ttfamily,
%identifierstyle=\color{Blue}\ttfamily,
%functionstyle=\color{Blue}\ttfamily,
%typestyle=\color{ForestGreen}\ttfamily,
stringstyle=\color{Tan}\ttfamily,%
morekeywords={,complex,}%
frame=none,%
backgroundcolor=\color{LightGrey}%
}

\lstdefinestyle{myMatlab}{%
language=Matlab,
showstringspaces=false,
basicstyle=\small\ttfamily,
commentstyle=\color{BrickRed}\ttfamily,
keywordstyle=\color{Purple}\ttfamily,
%identifierstyle=\color{Blue}\ttfamily,
%functionstyle=\color{Blue}\ttfamily,
%typestyle=\color{ForestGreen}\ttfamily,
stringstyle=\color{Tan}\ttfamily,%
frame=none,%
backgroundcolor=\color{LightGrey}%
}

\lstdefinestyle{myScilab}{%
language=Scilab,
showstringspaces=false,
basicstyle=\small\ttfamily,
commentstyle=\color{BrickRed}\ttfamily,
keywordstyle=\color{Purple}\ttfamily,
%identifierstyle=\color{Blue}\ttfamily,
%functionstyle=\color{Blue}\ttfamily,
%typestyle=\color{ForestGreen}\ttfamily,
stringstyle=\color{Tan}\ttfamily,%
frame=none,%
backgroundcolor=\color{LightGrey}%
}

\lstdefinestyle{myShell}{%
language=ksh,
showstringspaces=false,
basicstyle=\small\ttfamily,
commentstyle=\color{Black}\ttfamily,
keywordstyle=\color{Black}\ttfamily,
%identifierstyle=\color{Blue}\ttfamily,
%functionstyle=\color{Blue}\ttfamily,
%typestyle=\color{ForestGreen}\ttfamily,
stringstyle=\color{Black}\ttfamily,%
frame=none,%
backgroundcolor=\color{LightGrey}%
}

\lstdefinestyle{myFootnotesizeShell}{%
language=ksh,
showstringspaces=false,
basicstyle=\footnotesize\ttfamily,
commentstyle=\color{Black}\ttfamily,
keywordstyle=\color{Black}\ttfamily,
%identifierstyle=\color{Blue}\ttfamily,
%functionstyle=\color{Blue}\ttfamily,
%typestyle=\color{ForestGreen}\ttfamily,
stringstyle=\color{Black}\ttfamily,%
frame=none,%
backgroundcolor=\color{LightGrey}%
}

\lstdefinestyle{myPython}{%
language=python,
showstringspaces=false,
basicstyle=\small\ttfamily,
commentstyle=\color{BrickRed}\ttfamily,
keywordstyle=\color{Purple}\ttfamily,
%identifierstyle=\color{Blue}\ttfamily,
%functionstyle=\color{Blue}\ttfamily,
%typestyle=\color{ForestGreen}\ttfamily,
stringstyle=\color{Tan}\ttfamily,%
frame=none,%
%backgroundcolor=\color{LightGrey}%
}

\lstdefinestyle{myhtml}{%
language=xml,
showstringspaces=false,
basicstyle=\small\ttfamily,
commentstyle=\color{BrickRed}\ttfamily,
keywordstyle=\color{Purple}\ttfamily,
%identifierstyle=\color{Blue}\ttfamily,
%functionstyle=\color{Blue}\ttfamily,
%typestyle=\color{ForestGreen}\ttfamily,
stringstyle=\color{Tan}\ttfamily,
morekeywords={,simulation,prop_dim,error_check,stochastic,%
  globals,field,dimensions,lattice,domains,samples,vector,%
  components,fourier_space,sequence,integrate,algorithm,%
  interval,k_operators,constant,operator_names,vectors,%
  output,filename,group,sampling,moments,benchmark,use_double,%
  use_wisdom,use_prefs,binary_output,cycles,filter,post_propagation,%
  default_value,argv,arg,iterations,cross_propagation,%
  use_mpi,paths,seed,noises,author,description,name,type,%
}
frame=none,%
%framerule=2pt,%
backgroundcolor=\color{LightGrey}%
}


% this implements producing nice code blocks
% it also saves time, typing and
% *should* reduce errors in the text by removing doubling up of code
\lstnewenvironment{xmdsCode}[1][]{\lstset{style=myhtml}\lstset{#1}}{}

% this implements nicely formatted shell code
\lstnewenvironment{shellCode}[1][]{\lstset{style=myShell}\lstset{#1}}{}

% this implements nicely formatted footnotesize shell code
\lstnewenvironment{smallShellCode}[1][]{\lstset{style=myFootnotesizeShell}\lstset{#1}}{}

% this implements nicely formatted Perl code
\lstnewenvironment{perlCode}[1][]{\lstset{style=myPerl}\lstset{#1}}{}

% this implements nicely formatted Python code
\lstnewenvironment{python}[1][]{\lstset{style=myPython}\lstset{#1}}{}

% this implements nicely formatted C++ code
\lstnewenvironment{CCode}{\lstset{style=myC++}}{}

% this implements nicely formatted matlab code
\lstnewenvironment{matlabCode}{\lstset{style=myMatlab}}{}

% this implements nicely formatted scilab code
\lstnewenvironment{scilabCode}{\lstset{style=myScilab}}{}
1	ahallam	3385
2	caltinay	5293	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3	jfenwick	6651	% Copyright (c) 2003-2018 by The University of Queensland
4	caltinay	5293	% http://www.uq.edu.au
5			%
6			% Primary Business: Queensland, Australia
7	jfenwick	6112	% Licensed under the Apache License, version 2.0
8			% http://www.apache.org/licenses/LICENSE-2.0
9	caltinay	5293	%
10			% Development until 2012 by Earth Systems Science Computational Center (ESSCC)
11			% Development 2012-2013 by School of Earth Sciences
12			% Development from 2014 by Centre for Geoscience Computing (GeoComp)
13			%
14			%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
15	ahallam	3385
16			\usepackage{listing}
17			% defines the colour for the background of code examples
18			\definecolor{LightGrey}{gray}{0.9}
19
20			%Some colour definitions added to keep pdflatex happy
21			%I make no claim that these values are particularly good
22			\definecolor{Purple}{rgb}{0.7, 0, 0.6}
23			\definecolor{Tan}{rgb}{0.5,0.5,0.5}
24			\definecolor{BrickRed}{rgb}{0.7, 0.2, 0.2}
25			\definecolor{Black}{rgb}{0, 0, 0}
26
27			% All the \color{x} used to be \color[named]{x}
28			%end color defs
29
30			\lstdefinestyle{myC++}{%
31			language=C++,
32			showstringspaces=false,
33			basicstyle=\small\ttfamily,
34			commentstyle=\color{BrickRed}\ttfamily,
35			keywordstyle=\color{Purple}\ttfamily,
36			%identifierstyle=\color{Blue}\ttfamily,
37			%functionstyle=\color{Blue}\ttfamily,
38			%typestyle=\color{ForestGreen}\ttfamily,
39			stringstyle=\color{Tan}\ttfamily,%
40			morekeywords={,complex,}%
41			frame=none,%
42			backgroundcolor=\color{LightGrey}%
43			}
44
45			\lstdefinestyle{myMatlab}{%
46			language=Matlab,
47			showstringspaces=false,
48			basicstyle=\small\ttfamily,
49			commentstyle=\color{BrickRed}\ttfamily,
50			keywordstyle=\color{Purple}\ttfamily,
51			%identifierstyle=\color{Blue}\ttfamily,
52			%functionstyle=\color{Blue}\ttfamily,
53			%typestyle=\color{ForestGreen}\ttfamily,
54			stringstyle=\color{Tan}\ttfamily,%
55			frame=none,%
56			backgroundcolor=\color{LightGrey}%
57			}
58
59			\lstdefinestyle{myScilab}{%
60			language=Scilab,
61			showstringspaces=false,
62			basicstyle=\small\ttfamily,
63			commentstyle=\color{BrickRed}\ttfamily,
64			keywordstyle=\color{Purple}\ttfamily,
65			%identifierstyle=\color{Blue}\ttfamily,
66			%functionstyle=\color{Blue}\ttfamily,
67			%typestyle=\color{ForestGreen}\ttfamily,
68			stringstyle=\color{Tan}\ttfamily,%
69			frame=none,%
70			backgroundcolor=\color{LightGrey}%
71			}
72
73			\lstdefinestyle{myShell}{%
74			language=ksh,
75			showstringspaces=false,
76			basicstyle=\small\ttfamily,
77			commentstyle=\color{Black}\ttfamily,
78			keywordstyle=\color{Black}\ttfamily,
79			%identifierstyle=\color{Blue}\ttfamily,
80			%functionstyle=\color{Blue}\ttfamily,
81			%typestyle=\color{ForestGreen}\ttfamily,
82			stringstyle=\color{Black}\ttfamily,%
83			frame=none,%
84			backgroundcolor=\color{LightGrey}%
85			}
86
87	aellery	6794	\lstdefinestyle{myFootnotesizeShell}{%
88			language=ksh,
89			showstringspaces=false,
90			basicstyle=\footnotesize\ttfamily,
91			commentstyle=\color{Black}\ttfamily,
92			keywordstyle=\color{Black}\ttfamily,
93			%identifierstyle=\color{Blue}\ttfamily,
94			%functionstyle=\color{Blue}\ttfamily,
95			%typestyle=\color{ForestGreen}\ttfamily,
96			stringstyle=\color{Black}\ttfamily,%
97			frame=none,%
98			backgroundcolor=\color{LightGrey}%
99			}
100
101	ahallam	3385	\lstdefinestyle{myPython}{%
102			language=python,
103			showstringspaces=false,
104			basicstyle=\small\ttfamily,
105			commentstyle=\color{BrickRed}\ttfamily,
106			keywordstyle=\color{Purple}\ttfamily,
107			%identifierstyle=\color{Blue}\ttfamily,
108			%functionstyle=\color{Blue}\ttfamily,
109			%typestyle=\color{ForestGreen}\ttfamily,
110			stringstyle=\color{Tan}\ttfamily,%
111			frame=none,%
112			%backgroundcolor=\color{LightGrey}%
113			}
114
115			\lstdefinestyle{myhtml}{%
116			language=xml,
117			showstringspaces=false,
118			basicstyle=\small\ttfamily,
119			commentstyle=\color{BrickRed}\ttfamily,
120			keywordstyle=\color{Purple}\ttfamily,
121			%identifierstyle=\color{Blue}\ttfamily,
122			%functionstyle=\color{Blue}\ttfamily,
123			%typestyle=\color{ForestGreen}\ttfamily,
124			stringstyle=\color{Tan}\ttfamily,
125			morekeywords={,simulation,prop_dim,error_check,stochastic,%
126			globals,field,dimensions,lattice,domains,samples,vector,%
127			components,fourier_space,sequence,integrate,algorithm,%
128			interval,k_operators,constant,operator_names,vectors,%
129			output,filename,group,sampling,moments,benchmark,use_double,%
130			use_wisdom,use_prefs,binary_output,cycles,filter,post_propagation,%
131			default_value,argv,arg,iterations,cross_propagation,%
132			use_mpi,paths,seed,noises,author,description,name,type,%
133			}
134			frame=none,%
135			%framerule=2pt,%
136			backgroundcolor=\color{LightGrey}%
137			}
138
139
140			% this implements producing nice code blocks
141			% it also saves time, typing and
142			% should reduce errors in the text by removing doubling up of code
143			\lstnewenvironment{xmdsCode}[1][]{\lstset{style=myhtml}\lstset{#1}}{}
144
145			% this implements nicely formatted shell code
146			\lstnewenvironment{shellCode}[1][]{\lstset{style=myShell}\lstset{#1}}{}
147
148	aellery	6794	% this implements nicely formatted footnotesize shell code
149			\lstnewenvironment{smallShellCode}[1][]{\lstset{style=myFootnotesizeShell}\lstset{#1}}{}
150
151	ahallam	3385	% this implements nicely formatted Perl code
152			\lstnewenvironment{perlCode}[1][]{\lstset{style=myPerl}\lstset{#1}}{}
153
154			% this implements nicely formatted Python code
155			\lstnewenvironment{python}[1][]{\lstset{style=myPython}\lstset{#1}}{}
156
157			% this implements nicely formatted C++ code
158			\lstnewenvironment{CCode}{\lstset{style=myC++}}{}
159
160			% this implements nicely formatted matlab code
161			\lstnewenvironment{matlabCode}{\lstset{style=myMatlab}}{}
162
163			% this implements nicely formatted scilab code
164	caltinay	5293	\lstnewenvironment{scilabCode}{\lstset{style=myScilab}}{}