Changeset 1125 in lmdz_wrf for trunk/tools/generic_tools.py

Timestamp:

Sep 30, 2016, 6:36:03 PM (8 years ago)

Author:

lfita

Message:

Adding:

• `ASCII_LaTeX': Function to transform from an ASCII character to LaTeX codification
• `latex_text': Function to transform a text to LaTeX following style rules

File:

• trunk/tools/generic_tools.py (modified) (4 diffs)

trunk/tools/generic_tools.py

@@ +1 @@
+# -*- coding: iso-8859-15 -*-
 import numpy as np
 from netCDF4 import Dataset as NetCDFFile
@@ -26 +27 @@
 
 ####### Content
+# ASCII_LaTeX: Function to transform from an ASCII character to LaTeX codification
 # Capturing: Class to capture the standard output from a function
 # CFmonthU_daysU: Function to transform from a CF date series with units as 'months since [DATE]' to 'days since [DATE]'
@@ -56 +58 @@
 # index_vec: Function to provide the coordinates of a given value inside a vector
 # julday_360d: Function to provide the julian day of a date in a 360 days/yr (or 12 30-days months) calendar
+# latex_text: Function to transform a text to LaTeX following style rules
 # list_combos: Function to construct a new list with all possible N-combinations of the list-values
 # list_coincidences: Function to provide the coincidences between two lists
@@ -9294 +9297 @@
     return newmat
 
+def ASCII_LaTeX(ln):
+    """ Function to transform from an ASCII character to LaTeX codification
+    >>> ASCII_LaTeX('Laboratoire de Météorologie Dynamique però Hovmöller \¿')
+    Laboratoire de M\'et\'eorologie Dynamique per\`o Hovm\"oller \textbackslash¿`
+    """
+
+    newln = ln.replace('\\', '\\textbackslash')
+
+    newln = newln.replace('á', "\\'a")
+    newln = newln.replace('é', "\\'e")
+    newln = newln.replace('í', "\\'i")
+    newln = newln.replace('ó', "\\'o")
+    newln = newln.replace('ú', "\\'u")
+
+    newln = newln.replace('Ã ', "\\`a")
+    newln = newln.replace('Ú', "\\`e")
+    newln = newln.replace('ì', "\\`i")
+    newln = newln.replace('ò', "\\`o")
+    newln = newln.replace('ù', "\\`u")
+
+    newln = newln.replace('â', "\\^a")
+    newln = newln.replace('ê', "\\^e")
+    newln = newln.replace('î', "\\^i")
+    newln = newln.replace('ÃŽ', "\\^o")
+    newln = newln.replace('û', "\\^u")
+
+    newln = newln.replace('À', '\\"a')
+    newln = newln.replace('ë', '\\"e')
+    newln = newln.replace('ï', '\\"i')
+    newln = newln.replace('ö', '\\"o')
+    newln = newln.replace('Ì', '\\"u')
+
+    newln = newln.replace('ç', '\c{c}')
+    newln = newln.replace('ñ', '\~{n}')
+
+    newln = newln.replace('Á', "\\'A")
+    newln = newln.replace('É', "\\'E")
+    newln = newln.replace('Í', "\\'I")
+    newln = newln.replace('Ó', "\\'O")
+    newln = newln.replace('Ú', "\\'U")
+
+    newln = newln.replace('À', "\\`A")
+    newln = newln.replace('È', "\\`E")
+    newln = newln.replace('Ì', "\\`I")
+    newln = newln.replace('Ò', "\\`O")
+    newln = newln.replace('Ù', "\\`U")
+
+    newln = newln.replace('Â', "\\^A")
+    newln = newln.replace('Ê', "\\^E")
+    newln = newln.replace('Î', "\\^I")
+    newln = newln.replace('Ô', "\\^O")
+    newln = newln.replace('Û', "\\^U")
+
+    newln = newln.replace('Ä', '\\"A')
+    newln = newln.replace('Ë', '\\"E')
+    newln = newln.replace('Ï', '\\"I')
+    newln = newln.replace('Ö', '\\"O')
+    newln = newln.replace('Ü', '\\"U')
+
+    newln = newln.replace('Ç', '\\c{C}')
+    newln = newln.replace('Ñ', '\\~{N}')
+
+    newln = newln.replace('¡', '!`')
+    newln = newln.replace('¿', '¿`')
+    newln = newln.replace('%', '\\%')
+    newln = newln.replace('#', '\\#')
+    newln = newln.replace('&', '\\&')
+    newln = newln.replace('$', '\\$')
+    newln = newln.replace('_', '\\_')
+    newln = newln.replace('·', '\\textperiodcentered')
+    newln = newln.replace('<', '$<$')
+    newln = newln.replace('>', '$>$')
+    newln = newln.replace('', '*')
+#    newln = newln.replace('º', '$^{\\circ}$')
+    newln = newln.replace('ª', '$^{a}$')
+    newln = newln.replace('º', '$^{o}$')
+    newln = newln.replace('°', '$^{\\circ}$')
+    newln = newln.replace('\n', '\\\\\n')
+    newln = newln.replace('\t', '\\medskip')
+    newln = newln.replace('“', '``')
+    newln = newln.replace('”', '\'\'')
+
+    return newln
+
+def latex_text(itext):
+    """ Function to transform a text to LaTeX following style rules
+      itext: original text
+      >>> latex_text('US use the dolar $ as in AUS')
+      US use the dolar \$ as in AUS
+      >>> latex_text('definition of sinus: $\sin=\\frac{a}{\\sqrt{a^2+b^2}}$')
+      definition of sinus: $\sin=\frac{a}{\sqrt{a^2+b^2}}$
+      >>> latex_text('WRF_LMDZ$_{current}^{AR40}$')
+      WRF\_LMDZ$_{current}^{AR40}$
+    """
+    function = 'latex_text'
+
+    # Sesitive characters which might interfer with the mathematical environment
+    symbs = {'sub': '_', 'sup':'^', 'slash':'\\'}
+
+    # Do not change that sensitive_math which are between $ (from mathematical notation)
+    latexsymb = {}
+
+    Litext = len(itext)
+    for ic in range(Litext):
+        if itext[ic] == '$': 
+            if latexsymb.has_key('math'):
+                vals = latexsymb['math']
+                vals.append(ic)
+            else:
+                vals = [ic]
+            latexsymb['math'] = vals
+        elif itext[ic] == '_': 
+            if latexsymb.has_key('sub'):
+                vals = latexsymb['sub']
+                vals.append(ic)
+            else:
+                vals = [ic]
+            latexsymb['sub'] = vals
+        elif itext[ic] == '^':
+            if latexsymb.has_key('sup'):
+                vals = latexsymb['sup']
+                vals.append(ic)
+            else:
+                vals = [ic]
+            latexsymb['sup'] = vals
+        elif itext[ic] == '\\':
+            if latexsymb.has_key('slash'):
+                vals = latexsymb['slash']
+                vals.append(ic)
+            else:
+                vals = [ic]
+            latexsymb['slash'] = vals
+
+    latextext = itext + ''
+    for car in symbs.keys():
+        changecar = ASCII_LaTeX(symbs[car])
+        if latexsymb.has_key(car):
+            if not latexsymb.has_key('math') or len(latexsymb['math']) == 1:
+                latextext = latextext.replace(car,changecar)
+            else:
+                # Changing that characters which are outside an even 'math' pair
+                mathpos = latexsymb['math']
+                Nmath = len(mathpos)
+                if np.mod(Nmath,2) != 0 and Nmath > 1:
+                    print errormsg
+                    print '  '+fname + ': even number', Nmath,' of math symbols $ !!'
+                    print '    impossible to determine where starts math environment '
+                    print "    change text: '" + itext + "'"
+                    quit(-1)
+
+                for isymb in latexsymb[car]:
+                    Ltxt = len(latextext)
+                    if Nmath == 2:
+                        # Case with only 2 $
+                        mathbeg = mathpos[0]
+                        mathend = mathpos[1]
+                        if isymb < mathbeg or isymb > mathend:
+                            headtxt = latextext[0:isymb]
+                            tailtxt = latextext[isymb+1:Ltxt+1]
+                            latextext = headtxt + changecar + tailtxt
+                    else:
+                        # Case with more than 2 $
+                        for imath in range(0,Nmath,2):
+                            mathbeg = mathpos[imath]
+                            mathend = mathpos[imath+1]
+                            mathnext = mathpos[imath+2]   
+                            if isymb < mathbeg and (isymb > mathend and isymb < mathnext):
+                                headtxt = latextext[0:isymb]
+                                tailtxt = latextext[isymb+1:Ltxt+1]
+                                latextext = headtxt + changecar + tailtxt
+                                break
+    # Only 1 mathematical sign
+    Ltxt = len(latextext)
+    if len(latexsymb['math']) == 1:
+        isymb = latexsymb['math'][0]
+        headtxt = latextext[0:isymb]
+        tailtxt = latextext[isymb+1:Ltxt+1]
+        latextext = headtxt + '\\$' + tailtxt
+
+    return latextext
+
 #quit()