# Contents of /trunk/doc/cookbook/escpybas.tex

Revision 2634 - (show annotations)
Thu Aug 27 04:03:32 2009 UTC (11 years, 4 months ago) by ahallam
File MIME type: application/x-tex
File size: 5334 byte(s)
Updates to cookbook. Updates to scripts. Updates to figures. Working examples added to SCons. Data folder structure included minus data. More folder rejigging.

 1 2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 3 % 4 % Copyright (c) 2003-2009 by University of Queensland 5 % Earth Systems Science Computational Center (ESSCC) 6 7 % 8 % Primary Business: Queensland, Australia 9 % Licensed under the Open Software License version 3.0 10 11 % 12 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% 13 14 \section{Escript and Python Basics} \label{sec:escpybas} 15 16 The Python scripting language is a powerful and easy to learn environment with a wide variety of applications. \textit{Escript} has been developed as a packaged module for Python specifically to solve complex partial differential equations. As a result, all the conventions and programming syntaxes associated with Python are coherrent with \ESCRIPT. If you are unfamiliar with Python, there are a large number of simple to advanced guides and tutorials availabe online. These texts should provide an introduction that is comprehensive enough for the use of \ESCRIPT. A handful of python tutorials have been listed below. 17 \begin{itemize} 18 \item This is a very crisp introduction \url{http://hetland.org/writing/instant-python.html}. It covers everthing you need to get started with \ESCRIPT. 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 python authors: \url{http://www.python.org/doc/2.5.2/tut/tut.html}. It covers much more than what you will ever need for \ESCRIPT. 22 \item Another comprehensive tutorial: \url{http://www.tutorialspoint.com/python/index.htm} 23 \end{itemize} 24 25 \subsection{The \modesys Library Tree} 26 The \verb esys library tree has \textbf{3} main modules.\verb escript , \verb finley and \verb pycad . 27 \begin{enumerate} 28 \item \modescript is the PDE solving module. 29 \item \modfinley is the discretisation tool and is the finite element package. 30 \item \modpycad is a special development for creating irregular domains and models. 31 \end{enumerate} 32 Further explanations on each of these is available in the user guide or in the API documentation at \url{http://www.access.edu.au/esys13/nightly/epydoc/index.html} . \ESCRIPT is also dependent on a few other open-source packages which are not maintained by the \ESCRIPT developers. These are \modnumpy an array and matrix handling package, \modmpl a simple plotting and visualisation tool, \modvtk the advanced plotting and visualisation package and ...... These packages are included with the binary release but may not be the most recent and up to date. 33 34 \subsection{File Commands and Opperations in \ESCRIPT} 35 A number of common file opperations and commands are used throughout this cookbook. It is often advantageous to implement these commands when large numbers of output files are generated or dependencies are located in other locations. 36 37 To develop an incrementing file name we can use the following convention. For this example we are going to use the \verb|os.path.join| command to join a subdirectory which already exists with the file name which we want to use for our output. The command is; 38 \begin{verbatim} 39 os.path.join(save_path,"data%03d.xml") %i 40 \end{verbatim} 41 There are two arguments to the \verb join command. The \verb save_path variable is a predefined string pointing to the directory we want to save our data in, for example a single subfolder called \verb data would be defined by; 42 \begin{verbatim} 43 save_path = "data" 44 \end{verbatim} 45 while a subfolder of \verb data called \verb ans_one would be defined by; 46 \begin{verbatim} 47 save_path = "data/ans_one" 48 \end{verbatim} 49 The second argument of \verb join \xspace contains a string which is the filename. We can use the opperator \verb|%| to increment our file names with the value \verb|i| our incrementing counter. The substring \verb %03d does this by defining the following parameters; 50 \begin{itemize} 51 \item \verb 0 becomes the padding number; 52 \item \verb 3 tells us the amount of padding numbers that are required; and 53 \item \verb d indicates the end of the \verb % operator. 54 \end{itemize} 55 To increment the file name a \verb %i is required directly after the operation the string is involed in. When correctly implemented the output files from this command would be place in the directory defined by \verb save_path as; 56 \begin{verbatim} 57 data001.xml 58 data002.xml 59 data003.xml 60 ... 61 \end{verbatim} 62 and so on. 63 64 \subsection{Visualisation and Plotting} 65 \ESCRIPT does not have any inhouse plotting capabilities and will only provide a data output. the \esc package is however, shipped with two external and independent plotting packages. They are \mpl \footnote{\url{http://matplotlib.sourceforge.net/}} and \verb VTK \footnote{\url{http://www.vtk.org/}} . The \mpl package is fully functional with each \esc distribution. Based on the \numpy array package \mpl is good for basic graphs and plots. The \verb VTK toolkit allows the \esc data to be exported in a standardised format with powerful visualisation capabilities. This format can be interpreted by many programs. In this cookbook \mayavi \footnote{\url{http://code.enthought.com/projects/mayavi/}} will be used to visualise \verb VTK files. \mayavi is not included with any \esc distribution.