doc/cookbook/escpybas.tex


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%
% Copyright (c) 2003-2010 by University of Queensland
% Earth Systems Science Computational Center (ESSCC)
% http://www.uq.edu.au/esscc
%
% Primary Business: Queensland, Australia
% Licensed under the Open Software License version 3.0
% http://www.opensource.org/licenses/osl-3.0.php
%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

\section{Escript and Python Basics} \label{sec:escpybas}

The \pyt scripting language is a powerful and easy to learn environment with a wide variety of applications. \esc has been developed as a packaged module for \pyt specifically to solve complex partial differential equations. As a result, all the conventions and programming syntax associated with \pyt are coherrent with \esc. If you are unfamiliar with \pyt, there are a large number of simple to advanced guides and tutorials available online. These texts should provide an introduction that is comprehensive enough to use \esc. A handful of \pyt tutorials are listed below.
\begin{itemize}
\item \url{http://hetland.org/writing/instant-python.html} is a very crisp introduction. It covers everything you need to get started with \esc.
\item A nice and easy to follow introduction: \url{http://www.sthurlow.com/python/}
\item Another crisp tutorial: \url{http://www.zetcode.com/tutorials/pythontutorial/}. 
 \item A very comprehensive tutorial from the \pyt authors: \url{http://www.python.org/doc/2.5.2/tut/tut.html}. It covers much more than what you will ever need for \esc.
\item Another comprehensive tutorial: \url{http://www.tutorialspoint.com/python/index.htm}
\end{itemize} 

\subsection{The \modesys Modules}
\esc is part of the \esys package. 
Apart from the particle simulation library
\verb|ESyS-Particle|\footnote{see \url{https://launchpad.net/esys-particle}} which is not covered
in this tutorial \esys also includes the following modules
\begin{enumerate}
\item \modescript is the PDE solving module.
\item \modfinley is the discretisation tool and finite element package.
\item \modpycad  is a package for creating irregular shaped domains.
\end{enumerate}
Further explanations of each of these are available in the \esc user guide or in the API documentation\footnote{Available from \url{https://launchpad.net/escript-finley/+download}}. 
\esc is also dependent on a few other open-source packages which are not maintained by the \esc development team. These are \modnumpy (an array and matrix handling package), \modmpl \footnote{\modnumpy and \modmpl are part of the SciPy package, see \url{http://www.scipy.org/}} (a simple plotting tool) and \verb gmsh \footnote{See \url{http://www.geuz.org/gmsh/}} (which is required by \modpycad). These packages (\textbf{except} for \verb gmsh ) are included with the support bundles. 

1
2	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3	%
4	% Copyright (c) 2003-2010 by University of Queensland
5	% Earth Systems Science Computational Center (ESSCC)
6	% http://www.uq.edu.au/esscc
7	%
8	% Primary Business: Queensland, Australia
9	% Licensed under the Open Software License version 3.0
10	% http://www.opensource.org/licenses/osl-3.0.php
11	%
12	%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
13
14	\section{Escript and Python Basics} \label{sec:escpybas}
15
16	The \pyt scripting language is a powerful and easy to learn environment with a wide variety of applications. \esc has been developed as a packaged module for \pyt specifically to solve complex partial differential equations. As a result, all the conventions and programming syntax associated with \pyt are coherrent with \esc. If you are unfamiliar with \pyt, there are a large number of simple to advanced guides and tutorials available online. These texts should provide an introduction that is comprehensive enough to use \esc. A handful of \pyt tutorials are listed below.
17	\begin{itemize}
18	\item \url{http://hetland.org/writing/instant-python.html} is a very crisp introduction. It covers everything you need to get started with \esc.
19	\item A nice and easy to follow introduction: \url{http://www.sthurlow.com/python/}
20	\item Another crisp tutorial: \url{http://www.zetcode.com/tutorials/pythontutorial/}.
21	\item A very comprehensive tutorial from the \pyt authors: \url{http://www.python.org/doc/2.5.2/tut/tut.html}. It covers much more than what you will ever need for \esc.
22	\item Another comprehensive tutorial: \url{http://www.tutorialspoint.com/python/index.htm}
23	\end{itemize}
24
25	\subsection{The \modesys Modules}
26	\esc is part of the \esys package.
27	Apart from the particle simulation library
28	\verb\|ESyS-Particle\|\footnote{see \url{https://launchpad.net/esys-particle}} which is not covered
29	in this tutorial \esys also includes the following modules
30	\begin{enumerate}
31	\item \modescript is the PDE solving module.
32	\item \modfinley is the discretisation tool and finite element package.
33	\item \modpycad is a package for creating irregular shaped domains.
34	\end{enumerate}
35	Further explanations of each of these are available in the \esc user guide or in the API documentation\footnote{Available from \url{https://launchpad.net/escript-finley/+download}}.
36	\esc is also dependent on a few other open-source packages which are not maintained by the \esc development team. These are \modnumpy (an array and matrix handling package), \modmpl \footnote{\modnumpy and \modmpl are part of the SciPy package, see \url{http://www.scipy.org/}} (a simple plotting tool) and \verb gmsh \footnote{See \url{http://www.geuz.org/gmsh/}} (which is required by \modpycad). These packages (\textbf{except} for \verb gmsh ) are included with the support bundles.
37