/[escript]/branches/stage3.1/doc/cookbook/escpybas.tex
ViewVC logotype

Annotation of /branches/stage3.1/doc/cookbook/escpybas.tex

Parent Directory Parent Directory | Revision Log Revision Log


Revision 2945 - (hide annotations)
Wed Feb 24 00:17:46 2010 UTC (9 years ago) by jfenwick
File MIME type: application/x-tex
File size: 2822 byte(s)
Bringing release stage up to trunk version 2944

1 ahallam 2411
2     %%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
3     %
4 jfenwick 2921 % Copyright (c) 2003-2010 by University of Queensland
5 ahallam 2411 % 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 ahallam 2494 \section{Escript and Python Basics} \label{sec:escpybas}
15 ahallam 2411
16 ahallam 2775 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 availabe online. These texts should provide an introduction that is comprehensive enough for the use of \esc. A handful of \pyt tutorials have been listed below.
17 ahallam 2494 \begin{itemize}
18 ahallam 2775 \item This is a very crisp introduction \url{http://hetland.org/writing/instant-python.html}. It covers everthing you need to get started with \esc.
19 ahallam 2494 \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 ahallam 2775 \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 ahallam 2494 \item Another comprehensive tutorial: \url{http://www.tutorialspoint.com/python/index.htm}
23     \end{itemize}
24    
25 gross 2861 \subsection{The \modesys Modules}
26     \esc is part of the \esys package.
27     Besides the particle simualation code
28     \verb|ESyS-Particle|\footnote{see \url{https://launchpad.net/esys-particle}} which is not covered
29     in this tutorial \esys includes the following modules
30 ahallam 2494 \begin{enumerate}
31 gross 2861 \item \modescript is the PDE solving module.
32 ahallam 2645 \item \modfinley is the discretisation tool and finite element package.
33 gross 2861 \item \modpycad is a special development for creating irregular shaped domains.
34 ahallam 2494 \end{enumerate}
35 gross 2861 Further explanations on each of these is available in the \esc user guide or in the API documentation\footnote{Available from \url{https://launchpad.net/escript-finley/+download}}.
36 jfenwick 2945 \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 ahallam 2494

  ViewVC Help
Powered by ViewVC 1.1.26