Index: sm/workshop/2012/Talks/01_Teasers/01_Teasers.tex =================================================================== --- /issm/workshop/2012/Talks/01_Teasers/01_Teasers.tex (revision 14029) +++ (revision ) @@ -1,530 +1,0 @@ -%Preamble {{{ -\documentclass[10pt,notes=hide]{beamer} % Document class: beamer %8 pts is also a good option -\usetheme[jpl,headstyle=institute,fnolabel=,sidebar=.15\paperwidth,footstyle=low,footsep={ $\cdot$ },TPomitframeno]{Pasadena} -\useinnertheme{MLHacks} % ISSM bonuses (ghostframes for example) -\usepackage[T1]{fontenc} % T1 encoding is better for foreign langages -\usepackage{aeguill,aecompl} % Virtual fonts -\usepackage{amsmath,amssymb,amsfonts}% Mathematical symbols (useful for equations) -\usepackage{bm} % maths letters, real = IR -\usepackage{xcolor} % We can define new colors -\usepackage{graphicx} % Include pictures -\usepackage{times} % Use Times Font instead of default -\usepackage{appendixnumberbeamer} -\usepackage[framed,numbered,autolinebreaks,useliterate]{mcode} -\usepackage{booktabs} %nice tables (toprule, bottomrule,...) -\graphicspath{ % directories where the pictures are located -{Images/} -} -\hypersetup{pdfstartview={Fit}} % Acrobat reader: open fit to screen - -\setbeamercovered{transparent} %invisible, transparent, dynamic, highly dynamic -%}}} -%Newcommands {{{ -%%Automatically insert outline slide at the begining of each new section (very nice!) -%\AtBeginSection[]{ -%\begin{frame} -% \ghostframe %do not count slide -% \frametitle{Outline} % title of the slide -% \tableofcontents[currentsection] -%\end{frame} -%} -%}}} -%Presentation properties{{{ -%between brackets []: shown on headers and footers of every slide (must be short) -%between parenthesis (): shown on title page only (long) -\title[Teasers]{Ice Sheet System Model} -\subtitle{Teasers} -\author[Larour et al.]{ -Eric \textsc{Larour}\inst{1}, -Eric \textsc{Rignot}\inst{1,3}, -Mathieu \textsc{Morlighem}\inst{1,2}, -H\'el\`ene \textsc{Seroussi}\inst{1,2} -\textbf{Chris \textsc{Borstad}}\inst{1}, -Feras \textsc{Habbal}\inst{1,3}, -Daria \textsc{Halkides}\inst{1,4}, -John \textsc{Schiermeier}\inst{1}, -Nicole \textsc{Schlegel}\inst{1} -\vspace{1em} -} -\institute[Jet Propulsion Laboratory]{ -\inst{1}Jet Propulsion Laboratory - California Institute of Technology\\ -\inst{2}Laboratoire MSSMat, \'Ecole Centrale Paris, France\\ -\inst{3}University of California, Irvine\\ -\inst{4}Joint Institute for Regional Earth System Science \& Engineering, UCLA -} -\conference[ISSM Workshop 2012]{ISSM Workshop 2012} -\date[]{\hspace{-15em}December 2012\hspace{3em}\copyright Copyright 2012. All rights reserved} -\logo{\includegraphics[width=8em]{ISSMlogo}} -%}}} -\begin{document} - -%Title slide %{{{ -\begin{frame}[plain] %No headers or footers - %Do not change, this page is automatically generated - \ghostframe - \titlepage -\end{frame} %}}} -\begin{frame}{Overview}%{{{ - \tableofcontents -\end{frame}%}}} - -\section{Meshing} - -\begin{frame}{Meshing}%{{{ - basic mesh generation, using both python and matlab -\end{frame}%}}} - -\section{Plotting} - -\begin{frame}{Plotting}%{{{ -Basic plot functionality, using both matlab and python -\end{frame}%}}} - -%Thanks slide{{{ -\usebackgroundtemplate{\includegraphics[width=\paperwidth,height=\paperheight]{Thanksbg}} -\begin{frame}[plain] - \ghostframe - \begin{center} - \vspace*{-0.1\paperheight} - \hspace*{-0.15\paperwidth}\Huge{Thanks!} - \end{center} - \note{Thank you very much for your attention} -\end{frame} -\usebackgroundtemplate{} -%}}} - -%% slides from last year to possibly use {{{ -%\begin{frame}\frametitle{Startup file}%{{{ -% \begin{itemize} -% \item {\tt startup.m} must be present when matlab is launched -% \item Automatically executed by matlab at ``start up'' to load all ISSM tools -% \end{itemize} -% \lstinputlisting[firstline=14,lastline=34,basicstyle=\lstbasicfont\tiny]{Code/startup.m} -%\end{frame} -%%}}} -%\section{Model class} -%\begin{frame} \frametitle{Matlab Model class}%{{{ -% \vspace{-1em} -% \lstinputlisting[firstline=1,lastline=36,basicstyle=\lstbasicfont\tiny]{Code/ex3.m} -%\end{frame} -%%}}} -%\begin{frame} \frametitle{Model fields}%{{{ -% \begin{itemize} -% \item Model properties are sorted by type: -% \begin{itemize} -% \item mesh properties in {\tt md.mesh} -% \item material properties in {\tt md.material} -% \item ... -% \end{itemize} -% \item Each model field is itself a matlab object with fields -% \item Default parameters are provided (physical constants, etc) -% \end{itemize} -% -% \lstinputlisting[firstline=38,lastline=56,basicstyle=\lstbasicfont\tiny]{Code/ex3.m} -%\end{frame} -%%}}} -%\begin{frame} \frametitle{Saving and loading a model}%{{{ -% \begin{itemize} -% \item {\tt md} is a placeholder for all parameters, constants, geometrical properties, etc. -% \item No additional file required, everything is in ONE matlab variable. -% \item Use matlab's {\tt save} command to save a model in binary format -% \item Use {\tt loadmodel} to reload a model from a binary file -% \item[$\rightarrow$] makes sure that old models are loaded correctly -% \end{itemize} -% \lstinputlisting[firstline=1,lastline=18,basicstyle=\lstbasicfont\tiny]{Code/ex2.m} -%\end{frame} -%%}}} -%\section{Plots} -%\begin{frame} \frametitle{Display model fields}%{{{ -% \begin{itemize} -% \item {\tt plotmodel} can be used to display any model field/result -% \item Arguments (pairs of options): -% \begin{enumerate} -% \item model -% \item {\tt 'data'} -% \item name of model field -% \item name of option1 -% \item option1 value -% \item name of option2 -% \item option2 value -% \item ... -% \end{enumerate} -% \end{itemize} -% \lstinputlisting[firstline=25,lastline=29]{Code/ex2.m} -% \begin{itemize} -% \item More info: -% \begin{itemize} -% \item {\tt plotdoc} -% \item \url{http://issm.jpl.nasa.gov/documentation/usersmanual} -% \end{itemize} -% \end{itemize} -%\end{frame} -%%}}} -%\section{Mesh} -%\subsection{EXP files} -%\begin{frame} \frametitle{EXP format}%{{{ -% \begin{itemize} -% \item We rely on Argus' format for geometrical files -% \item Argus files have an {\tt exp} extension -% \item Example for a square domain: -% \end{itemize} -% \lstinputlisting{Code/Square.exp} -% \begin{itemize} -% \item ISSM has tools to read/write/modify {\tt exp} files -% \item This format is used for: -% \begin{itemize} -% \item domain outline (mesh boundary) -% \item floating ice extension -% \item flag elements or vertices inside a profile -% \end{itemize} -% \end{itemize} -%\end{frame} -%%}}} -%\subsection{triangle} -%\begin{frame} \frametitle{Mesh generation with triangle}%{{{ -% \begin{itemize} -% \item {\tt triangle} is used to generate simple uniform unstructured meshes -% \item Arguments: -% \begin{enumerate} -% \item model -% \item name (string) of the domain outline -% \item element mean size -% \end{enumerate} -% \end{itemize} -% \lstinputlisting[firstline=1,lastline=2]{Code/Square.m} -% \begin{itemize} -% \item To display the mesh: -% \end{itemize} -% \lstinputlisting[firstnumber=3,firstline=3,lastline=3]{Code/Square.m} -%\end{frame} -%%}}} -%\section{Parameterization} -%\begin{frame} \frametitle{Parameterization file}%{{{ -% \begin{itemize} -% \item The parameter file sets up all required fields of a model: -% \begin{itemize} -% \item Geometrical properties (Upper surface elevation, thickness,...) -% \item Boundary conditions (friction, front,...) -% \item Solver settings -% \item ... -% \end{itemize} -% \item Example for a square ice shelf: -% \lstinputlisting[basicstyle=\lstbasicfont\tiny]{Code/Square.par} -% \end{itemize} -%\end{frame} -%%}}} -%\subsection{Interpolation modules} -%\begin{frame} \frametitle{Interpolation modules}%{{{ -% \begin{itemize} -% \item Interpolation from a regular grid to a mesh: {\tt InterpFromGridToMesh} -% \lstinputlisting[firstline=21,lastline=21,basicstyle=\lstbasicfont\tiny,numbers=none]{Code/ex2.m} -% \item Interpolation from between two meshes: {\tt InterpFromMeshToMesh2d} -% \lstinputlisting[firstline=20,lastline=20,basicstyle=\lstbasicfont\tiny,numbers=none]{Code/ex2.m} -% \end{itemize} -%\end{frame} -%%}}} -%\subsection{SeaRISE example} -%\begin{frame} \frametitle{SeaRISE example}%{{{ -% \vspace{-1em} -% \lstinputlisting[basicstyle=\lstbasicfont\Tiny]{Code/Greenland.par} -%\end{frame} -%%}}} -%\section{Mask} -%\begin{frame} \frametitle{Mask}%{{{ -% \begin{itemize} -% \item {\tt setmask} is used to generate areas where ice is grounded and floating -% \item Arguments: -% \begin{enumerate} -% \item model -% \item floating ice domain -% \item grounded ice inside the floating ice -% \end{enumerate} -% \item Ice considered grounded by default -% \item Input files in Argus format -% \item Examples -% \begin{itemize} -% \item[] {\tt md=setmask(md,'','')} $\rightarrow$ all grounded -% \item[] {\tt md=setmask(md,'all','')} $\rightarrow$ all floating -% \item[] {\tt md=setmask(md,'IceShelves.exp','')} $\rightarrow$ grounded with some floating parts -% \item[] {\tt md=setmask(md,'all','Islands.exp')} $\rightarrow$ floating with some grounded parts -% \end{itemize} -% \end{itemize} -% \begin{itemize} -% \item To display the mask: -% \end{itemize} -% \lstinputlisting[firstnumber=1,firstline=58,lastline=58]{Code/ex3.m} -%\end{frame} -%%}}} -%\section{Flow equations} -%\begin{frame} \frametitle{Flow equation}%{{{ -% {\tt setflowequation} is used to generate the approximation used to compute the velocity -% -% \begin{itemize} -% \item Arguments: -% \begin{enumerate} -% \item model -% \item approximation names -% \item approximation domains -% \end{enumerate} -% \item Domains can be Argus files or array of element flags -% \item Approximation available -% \begin{itemize} -% \item stokes (Full-Stokes model) -% \item pattyn (Higher-order model) -% \item macayeal (Shallow Shelf Approximation) -% \item hutter (Shallow Ice Approximation) -% \end{itemize} -% \item Model coupling possible (see tomorrow's presentation) -% \end{itemize} -%\end{frame} -%%}}} -%\begin{frame} \frametitle{Flow equation}%{{{ -% {\tt setflowequation} is used to generate the approximation used to compute the velocity -% -% \begin{itemize} -% \item Examples -% \end{itemize} -% -% \lstinputlisting[basicstyle=\lstbasicfont\tiny,firstnumber=1,firstline=62,lastline=65]{Code/ex3.m} -% -% \begin{itemize} -% \item To display the type of approximation: -% \end{itemize} -% -% \lstinputlisting[firstnumber=1,firstline=60,lastline=60]{Code/ex3.m} -%\end{frame} -%%}}} -%\section{Diagnostic} -%\subsection{Diagnostic parameters} -%\begin{frame} \frametitle{Diagnostic parameters}%{{{ -% Most diagnostic parameters can be found in {\tt md.diagnostic} -% \vspace{-0.5em} -% \lstinputlisting[basicstyle=\lstbasicfont\Tiny,firstnumber=1,firstline=94,lastline=125]{Code/ex3.m} -% -% Launch diagnostic solution with: -% \vspace{-0.5em} -% \lstinputlisting[basicstyle=\lstbasicfont\tiny,firstnumber=1,firstline=149,lastline=149]{Code/ex3.m} -%\end{frame} -%%}}} -%\subsection{Boundary conditions} -%\begin{frame} \frametitle{Boundary conditions}%{{{ -% -% \begin{itemize} -% \item {\tt >> md=SetIceSheetBC(md)} -% \item[$\rightarrow$] Dirichlet BC for all nodes on boundary -% \item[] -% \item {\tt >> md=SetIceShelf(md,'Front.exp')} -% \item[$\rightarrow$] Neumann BC for all nodes on boundary in {\tt 'Front.exp'} -% \item[$\rightarrow$] Dirichlet BC for all other nodes on boundary -% \item[] -% \item {\tt >> md=SetMarineIceSheefBC(md)} -% \item[$\rightarrow$] Dirichlet BC for all nodes on grounded boundary -% \item[$\rightarrow$] Neumann BC for all nodes on floating boundary -% \end{itemize} -%\end{frame} -%%}}} -%\section{Prognostic} -%\begin{frame} \frametitle{Prognostic parameters}%{{{ -% -% Most prognostic parameters can be found in {\tt md.prognostic} -% -% \lstinputlisting[basicstyle=\lstbasicfont\tiny,firstnumber=1,firstline=71,lastline=82]{Code/ex3.m} -% -%\end{frame} -%%}}} -%\begin{frame} \frametitle{Prognostic parameters}%{{{ -% -% Use {\tt md.timestepping} to change the time step: -% \lstinputlisting[basicstyle=\lstbasicfont\tiny,firstnumber=1,firstline=84,lastline=92]{Code/ex3.m} -% -% Launch prognostic solution with: -% \lstinputlisting[basicstyle=\lstbasicfont\normalsize,firstnumber=1,firstline=151,lastline=151]{Code/ex3.m} -% -%\end{frame} -%%}}} -%\section{Transient 2D} -%\subsection{Transient solution} -%\begin{frame} \frametitle{Transient solution}%{{{ -% Most transient parameters can be found in {\tt md.transient} -% -% \lstinputlisting[basicstyle=\lstbasicfont\tiny,firstnumber=1,firstline=127,lastline=136]{Code/ex3.m} -% -% \vspace{0.5em} -% Transient solutions in 2D combine: -% \begin{itemize} -% \item diagnostic -% \item prognostic -% \item grounding line -% \end{itemize} -% -% \vspace{0.5em} -% $\rightarrow$ Some of these components can be deactivated -%\end{frame} -%%}}} -%\begin{frame} \frametitle{Transient solution}%{{{ -% -% Use {\tt md.timestepping} to change the time step: -% -% \lstinputlisting[basicstyle=\lstbasicfont\tiny,firstnumber=1,firstline=84,lastline=92]{Code/ex3.m} -% -% Launch transient solution with: -% \lstinputlisting[basicstyle=\lstbasicfont\normalsize,firstnumber=1,firstline=153,lastline=153]{Code/ex3.m} -%\end{frame} -%%}}} -%\section{Extrusion} -%\begin{frame} \frametitle{Extrusion}%{{{ -% \begin{itemize} -% \item {\tt extrude} is used to extrude the 2d mesh into a 3d mesh -% \item Arguments: -% \begin{enumerate} -% \item model -% \item number of layers -% \item lower extrusion exponent -% \item upper extrusion exponent (optional) -% \end{enumerate} -% \item Examples -% \end{itemize} -% \lstinputlisting[firstnumber=1,firstline=67,lastline=69]{Code/ex3.m} -% \begin{itemize} -% \item To display the mesh: -% \end{itemize} -% \lstinputlisting[firstnumber=1,firstline=3,lastline=3]{Code/Square.m} -%\end{frame} -%%}}} -%\section{Thermal} -%\begin{frame} \frametitle{Thermal solution}%{{{ -% Most thermal parameters can be found in {\tt md.thermal} -% -% \lstinputlisting[basicstyle=\lstbasicfont\tiny,firstnumber=1,firstline=138,lastline=147]{Code/ex3.m} -% -% \vspace{0.5em} -% Thermal solution in 3D only to compute -% \begin{itemize} -% \item thermal steady state -% \item thermal transient -% \item[$\rightarrow$] Controlled by {\tt md.timestepping.timestep} -% \end{itemize} -% -% \vspace{0.5em} -% Launch thermal solution with: -% \lstinputlisting[basicstyle=\lstbasicfont\normalsize,firstnumber=1,firstline=155,lastline=155]{Code/ex3.m} -% -%\end{frame} -%%}}} -%\section{Transient 3D} -%\begin{frame} \frametitle{Transient solution}%{{{ -% Most transient parameters can be found in {\tt md.transient} -% -% \lstinputlisting[basicstyle=\lstbasicfont\tiny,firstnumber=1,firstline=127,lastline=136]{Code/ex3.m} -% -% Transient solutions in 3D combine: -% \begin{itemize} -% \item thermal -% \item diagnostic -% \item prognostic -% \item grounding line -% \end{itemize} -% -% \vspace{0.5em} -% $\rightarrow$ Some of these components can be deactivated -%\end{frame} -%%}}} -% -%\section{Website} -% -%\begin{frame}\frametitle{ISSM Website Help Resources}% {{{ -% \begin{itemize} -% \item Installation (\url{issm.jpl.nasa.gov/installation}) -% \item Documentation (\url{issm.jpl.nasa.gov/documentation}) -% \begin{itemize} -% \item Ice Sheet Modeling fundamentals -% \item User's Manual -% \item Validation Manual -% \item Tutorials -% \item FAQ -% \end{itemize} -% %\item trac website (\url{https://issm-svn.jpl.nasa.gov:80/trac/issm}) -% %\item doxygen (\url{http://issm.jpl.nasa.gov/doxygen/doc_c/chtml/index.html}) -% % \begin{itemize} -% % \item C/C++ source code documentation -% % \end{itemize} -% \end{itemize} -%\end{frame}%}}} -%\begin{frame}\frametitle{\alert{Trac} Website}% {{{ -% Trac is an enhanced wiki and issue tracking system for software development projects. -% \begin{itemize} -% \item[$\rightarrow$] \url{https://issm.ess.uci.edu:80/trac/issm} -% \item[$\rightarrow$] Also available via "Developers Site" link on ISSM webpage -% \item[$\rightarrow$] Main page is a wiki -% \end{itemize} -% %\begin{description}[<+->][Browse Source] -% % \item[Wiki] Project wiki -% % \begin{itemize}[<+->] -% % \item Note the link "Correspondence between old model fields and new model fields" -% % \end{itemize} -% % \item[Timeline] Browser interface to the ISSM subversion version control system -% % \begin{itemize}[<+->] -% % \item Click on a changeset to view code changes -% % \end{itemize} -% % \item[Browse Source] Source code browser -% % \item[New Ticket] Submit a bug ticket -% %\end{description} -%\end{frame}%}}} -%\begin{frame}\frametitle{\alert{Doxygen} Website}% {{{ -%Doxygen is an online documentation and source code browser. The ISSM source code can be searched -%and browsed here: -% \begin{itemize} -% \item[$\rightarrow$] \url{http://issm.jpl.nasa.gov/doxygen/doc_c/chtml/index.html} -% \item[$\rightarrow$] "Doxygen" link on ISSM webpage -% \item Useful for learning about structure of code, searching for functions/classes/objects, -% learning class hierarchy, etc. -% \end{itemize} -%\end{frame}% }}} -% -%\section[Command-Line]{Command-Line Utilities} -% -%\begin{frame}\frametitle{MATLAB Help Resources}% {{{ -% \begin{itemize} -% \item Type 'issmdoc' at the command prompt to get started with ISSM -% \item Type 'help' followed by function/class/object name -% \begin{itemize} -% \item Works for ISSM-specific as well as generic MATLAB classes/functions/objects -% \end{itemize} -% \end{itemize} -% \lstinputlisting[firstline=6,lastline=8]{Code/ex1.m} -%\end{frame}%}}} -%\begin{frame}\frametitle{Plotting Help}% {{{ -% \begin{itemize} -% \item Type 'plotdoc' at the MATLAB command prompt for a list of plot capabilities and options -% \end{itemize} -% \lstinputlisting[firstline=5,lastline=5]{Code/ex1.m} -% \begin{itemize} -% \item Many plot examples in User's Manual (\url{issm.jpl.nasa.gov/documentation/usersmanual/}) -% \end{itemize} -%\end{frame}% }}} -% -%\section[Contacts]{Contacting the ISSM Team} -% -%%\begin{frame}\frametitle{ISSM Skype Channels}%{{{ -%% \includegraphics[width=0.9\textwidth]{skype-screenshot1.png} -%%\end{frame}%}}} -%\begin{frame}\frametitle{ISSM Skype Channels}%{{{ -% \includegraphics[width=0.9\textwidth]{skype-screenshot2.png} -%\end{frame}%}}} -%\begin{frame}\frametitle{ISSM Skype Channels}%{{{ -% \begin{itemize} -% \item "ISSM" is a running skype chat conversation among anyone involved in the development/use -% of ISSM -% \item This is the fastest and most convenient way to contact ISSM team members and get help -% \item To join this conversation, send a contact request to one of the ISSM team members. Once -% approved, he/she will add you to the conversation -% \end{itemize} -%\end{frame}%}}} -% -%\begin{frame}\frametitle{Requesting Additional Help}% {{{ -% Email the ISSM team at \texttt{issm@jpl.nasa.gov} -% -%\end{frame}% }}} -%%}}} - -\end{document} Index: sm/workshop/2012/Talks/01_Teasers/Makefile =================================================================== --- /issm/workshop/2012/Talks/01_Teasers/Makefile (revision 14029) +++ (revision ) @@ -1,40 +1,0 @@ -#Makefile for beamer -TARGET=01_Teasers - -export TEXINPUTS=$(JPL_SVN)/publications/templates/beamer/Theme/Pasadena//: - -all: one - -one: - pdflatex -halt-on-error -file-line-error $(TARGET).tex - open $(TARGET).pdf - -complete: - pdflatex -halt-on-error -file-line-error -draftmode $(TARGET).tex -# bibtex $(TARGET) - pdflatex -halt-on-error -file-line-error -draftmode $(TARGET).tex - pdflatex -halt-on-error -file-line-error $(TARGET).tex - open $(TARGET).pdf - -bib: - bibtex $(TARGET) - -links: - ln -s $(ISSM_DIR)/publications/templates/beamer/Theme/Pasadena/*.sty . - ln -s $(ISSM_DIR)/publications/templates/beamer/Theme/Pasadena/general/*.sty . - ln -s $(ISSM_DIR)/publications/templates/beamer/Theme/Pasadena/subtheme/*.sty . - ln -s $(ISSM_DIR)/publications/templates/beamer/Theme/Pasadena/ML/*.sty . - ln -s $(ISSM_DIR)/publications/templates/beamer/Theme/Pasadena/graphics/JPL/*.pdf . - -unlinks: - find . -maxdepth 1 -type l -print | xargs rm - -open: - open -a /Applications/Adobe\ Reader\ 9/Adobe\ Reader.app/ $(TARGET).pdf - -clean: - rm -f ${TARGET}.{dvi,ps,pdf,toc,log,aux,out,nav,snm,bbl,blg,vrb} - -allclean: - make clean - make unlinks Index: sm/workshop/2012/Talks/01_Teasers/mcode.sty =================================================================== --- /issm/workshop/2012/Talks/01_Teasers/mcode.sty (revision 14029) +++ (revision ) @@ -1,280 +1,0 @@ -%% -%% This is file `mcode.sty' -%% -%% It is supposed to help you easily include MATLAB source code -%% into LaTeX document, but have it nicely highlighted, using -%% the great listings package. -%% -%% PLEASE NOTE that this package does nothing but save you from -%% figuring out some configurations in setting up the LISTINGS -%% package. ALL the work is done by that package! Thus, please -%% refer your questions to the listings package documentation. -%% -%% Usage: You have three ways of including your MATLAB code. As -%% environment, as inline object and directly from an external -%% file. -%% -%% 1) Environment: -%% -%% \begin{lstlisting} -%% YOUR CODE HERE -%% \end{lstlisting} -%% -%% -%% 2) Inline object: -%% -%% Bla bla \mcode{CODEFRAGMENT} bla bla. -%% -%% -%% 3) Include external file (in environment form) -%% -%% \lstinputlisting{YOUR-FILE.m} -%% -%% -%% For your convenience this package has the following options: -%% -%% - bw if you intend to print the document (highlighting done -%% via text formatting (bold, italic) and shades of gray) -%% -%% - numbered if you want line numbers -%% -%% - autolinebreaks if you want the package to automatically -%% wrap your code. This is buggy as it may well break -%% break syntax and it doesn't work well with comments. -%% You REALLY should wrap your code manually. -%% -%% - useliterate if you want some characters / relations in -%% your code to be replace with something more readable. -%% Example: ~= becomes $\neq$, >= becomes $\geq$, delta -%% becomes $\delta$ and so on. -%% -%% - framed if you want a frame around the source code blocks -%% -%% - final if you have ``gloablly'' set the draft option, the -%% listings package will not output the code at all. to -%% force it to do so anyway, load this package with the -%% final option (passes the ``final'' on to listings). -%% -%% For example, you may use \usepackage[numbered,framed]{mcode} -%% in your document preamble. -%% -%% Note: Inside code blocks you can escape to LaTeX text mode -%% using §...§. For ex. §text and some math: $x^2$§, which is -%% especially useful in comments for putting nicely typeset -%% equations etc. To get the same colour/style as in the rest -%% of the comment use \mcommentfont, i.e. §\mcommentfont $x^2$§ -%% -%% To change the font used, edit the first line in the "custo- -%% mise below" section. And feel free to edit other things as -%% well. Refer to the documentation of the listings package to -%% see what else you could do. If an extra small font is re- -%% quired, use {\fontfamily{pcr}\fontsize{3}{4.6}\selectfont} -%% in the definition of \lstbasicfont. -%% -%% Author: -%% Florian Knorn | florian@knorn.org | www.florian-knorn.com -%% -%% Version history: -%% 2.2 -- Bugfix (thanks Willi Gerbig!) -%% 2.1 -- Finally automatic detection between end and end -%% 2.0 -- New options for line breaking and literate prog. -%% 1.8 -- Fixed typo in documentation regarding §...§ -%% 1.7 -- Added MATLAB block comment syntax %{ ...... %} -%% 1.6 -- Added some infos, dealing with keyword ``end'' -%% 1.5 -- Tweaked check to see wether textcomp is loaded -%% 1.4 -- Fixed misconfig (mathescape now set to false) -%% 1.3 -- Purely cosmetic (tabs replaced by spaces) -%% 1.2 -- Added \lstset{showstringspaces=false} -%% 1.1 -- Added \mcode command and [final] option -%% 1.0 -- Release - - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% D O N ' T T O U C H T H I S % -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -\def\fileversion{2.2} -\def\filedate{2011/08/26} - -\typeout{-- Package: `mcode' \fileversion\space <\filedate> --} -\NeedsTeXFormat{LaTeX2e} -\ProvidesPackage{mcode}[\filedate\space\fileversion] - -% for bw-option -\newif\ifbw -\DeclareOption{bw}{\bwtrue} - -% numbered option -\newif\ifnumbered -\DeclareOption{numbered}{\numberedtrue} - -% final option -\newif\iffinal -\DeclareOption{final}{\finaltrue} - -% autolinebreaks option -\newif\ifautolinebreaks -\DeclareOption{autolinebreaks}{\autolinebreakstrue} - -% literate programming (replace certain characters/relations -\newif\ifuseliterate -\DeclareOption{useliterate}{\useliteratetrue} - -% framed option -\newif\ifframed -\DeclareOption{framed}{\framedtrue} - -\DeclareOption*{% default - \PackageWarning{mcode}{Unknown option `\CurrentOption' !}% -} -\ProcessOptions - -\ifbw\typeout{ - settings optimized for printing (bw formating)} -\else\typeout{ - settings optimized for display (colour formating)}\fi -\ifnumbered\typeout{ - line numbering enabled}\else\fi -\ifuseliterate\typeout{ - literate programming (character replacements) enabled}\else\fi -\ifautolinebreaks\typeout{ - automatic line breaking enabled (careful, buggy!)}\else\fi -\ifframed\typeout{ - framed listings}\else\fi - -% This command allows you to typeset syntax highlighted Matlab -% code ``inline''. The font size \small seems to look best... -\newcommand{\mcode}[1]{\lstinline[basicstyle=\lstbasicfont\small]|#1|} - -% check if color command exists -\ifx\color\undefined% - \RequirePackage{xcolor}% -\fi - -% check if listings has been loaded -\ifx\lstset\undefined% - \iffinal - \RequirePackage[final]{listings} - \else - \RequirePackage{listings} - \fi -\fi - -% Check if textcomp has been loaded (this package is needed for -% upright quotes '' (instead of typographic ones `´)... -\ifx\textquotesingle\undefined% - \RequirePackage{textcomp}% -\fi - -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% -% C U S T O M I S E B E L O W % -%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%% - -% --------------------------------------------------------------------------------- -% default font -\def\lstbasicfont{\fontfamily{pcr}\selectfont\footnotesize} - -% --------------------------------------------------------------------------------- -% matlat languate definition -\lstdefinelanguage{matlabfloz}{% - alsoletter={...},% - morekeywords={% % keywords - break,case,catch,continue,elseif,else,end,for,function,global,% - if,otherwise,persistent,return,switch,try,while,...},% - comment=[l]\%, % comments - morecomment=[l]..., % comments - morecomment=[s]{\%\{}{\%\}}, % block comments - morestring=[m]' % strings -}[keywords,comments,strings]% - -% --------------------------------------------------------------------------------- -% general definitions -\lstset{% - basicstyle={\lstbasicfont}, % set font - showstringspaces=false, % do not emphasize spaces in strings - tabsize=3, % number of spaces of a TAB - mathescape=false,escapechar=§, % escape to latex with §...§ - upquote=true, % upright quotes - aboveskip={1.5\baselineskip}, % a bit of space above listings - columns=fixed % nice spacing -} - -% --------------------------------------------------------------------------------- -% define colours and styles -\ifbw % use font formating and gray 'colors' - \def\mcommentfont{\color[gray]{.75}\itshape} %comments light gray and italic - \lstset{language=matlabfloz, % use our version of highlighting - keywordstyle=\bfseries, % keywords in bold - commentstyle=\mcommentfont, % comments - stringstyle=\color[gray]{0.5} % strings darker gray - } -\else% notbw => use colors : ) - \def\mcommentfont{\color[rgb]{.133,.545,.133}} %comments in green - \lstset{language=matlabfloz, % use our version of highlighting - keywordstyle=\color[rgb]{0,0,1}, % keywords in blue - commentstyle=\mcommentfont, % comments - stringstyle=\color[rgb]{.627,.126,.941} % strings in purple - } -\fi%bw - -% --------------------------------------------------------------------------------- -% automatic line breaking --- warning, this is buggy and -% doesn't break comments correctly! -\ifautolinebreaks - \newsavebox{\lbreakdots}\sbox{\lbreakdots}{\lstbasicfont\mcommentfont...} - \lstset{breaklines=true,breakatwhitespace=true,prebreak=\usebox{\lbreakdots}} -\fi - -% --------------------------------------------------------------------------------- -% literate replacements -% the following is for replacing some matlab relations like >= or ~= -% by the corresponding LaTeX symbols, which are much easier to read ... -\ifuseliterate - \lstset{% - literate=% - {~}{{$\neg$}}1 % \neg - {<=}{{\tiny$\leq$}}1 % \leq - {>=}{{\tiny$\geq$}}1 % \geq - {~=}{{\tiny$\neq$}}1 % \neq - {delta}{{\tiny$\Delta$}}1 % \Delta - {(end)}{\lstbasicfont (end)}{5} % black ``end'' when indexing last vector element - {({ }end)}{\lstbasicfont ({ }end)}{6} - {(end{ })}{\lstbasicfont (end{ })}{6} - {({ }end{ })}{\lstbasicfont ({ }end{ })}{7} - {:end}{\lstbasicfont :end}{4} - {:{ }end}{\lstbasicfont :{ }end}{5} - {end:}{\lstbasicfont end:}{4} - {end{ }:}{\lstbasicfont end{ }:}{5} - {,end}{\lstbasicfont ,end}{4} - {,{ }end}{\lstbasicfont ,{ }end}{5} - } -\else - \lstset{% - literate=% - {(end)}{\lstbasicfont (end)}{5} % black ``end'' when indexing last vector element - {({ }end)}{\lstbasicfont ({ }end)}{6} - {(end{ })}{\lstbasicfont (end{ })}{6} - {({ }end{ })}{\lstbasicfont ({ }end{ })}{7} - {:end}{\lstbasicfont :end}{4} - {:{ }end}{\lstbasicfont :{ }end}{5} - {end:}{\lstbasicfont end:}{4} - {end{ }:}{\lstbasicfont end{ }:}{5} - {,end}{\lstbasicfont ,end}{4} - {,{ }end}{\lstbasicfont ,{ }end}{5} - } -\fi%literates - -% --------------------------------------------------------------------------------- -% line numbering -\ifnumbered% numbered option - \lstset{% - numbersep=3mm, numbers=left, numberstyle=\tiny, % number style - } -\fi - -\ifframed% framed option - \lstset{% - frame=single, % frame - } - \ifnumbered% - \lstset{% - framexleftmargin=6mm, xleftmargin=6mm % tweak margins - } - \fi -\fi - -\endinput -%% End of file `mcode.sty'.