/[escript]/trunk/doc/cookbook/escpybas.tex
ViewVC logotype

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

Parent Directory Parent Directory | Revision Log Revision Log


Revision 3989 - (show annotations)
Tue Sep 25 02:21:54 2012 UTC (7 years ago) by jfenwick
File MIME type: application/x-tex
File size: 2927 byte(s)
More copyright fixes.
pyvisi traces removed.
Some install doco
1
2 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3 % Copyright (c) 2003-2012 by University of Queensland
4 % http://www.uq.edu.au
5 %
6 % Primary Business: Queensland, Australia
7 % Licensed under the Open Software License version 3.0
8 % http://www.opensource.org/licenses/osl-3.0.php
9 %
10 % Development until 2012 by Earth Systems Science Computational Center (ESSCC)
11 % Development since 2012 by School of Earth Sciences
12 %
13 %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
14
15 \section{Escript and Python Basics} \label{sec:escpybas}
16
17 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 coherent 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.
18 \begin{itemize}
19 \item \url{http://hetland.org/writing/instant-python.html} is a very crisp introduction. It covers everything you need to get started with \esc.
20 \item A nice and easy to follow introduction: \url{http://www.sthurlow.com/python/}
21 \item Another crisp tutorial: \url{http://www.zetcode.com/tutorials/pythontutorial/}.
22 \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.
23 \item Another comprehensive tutorial: \url{http://www.tutorialspoint.com/python/index.htm}
24 \end{itemize}
25
26 \subsection{The \modesys Modules}
27 \esc is part of the \esys package.
28 Apart from the particle simulation library
29 \verb|ESyS-Particle|\footnote{see \url{https://launchpad.net/esys-particle}} which is not covered
30 in this tutorial \esys also includes the following modules
31 \begin{enumerate}
32 \item \modescript is the PDE solving module.
33 \item \modfinley is the discretisation tool and finite element package.
34 \item \modpycad is a package for creating irregular shaped domains.
35 \end{enumerate}
36 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}}.
37 \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.
38

  ViewVC Help
Powered by ViewVC 1.1.26