tikzplotly 0.1.3__tar.gz → 0.1.4__tar.gz

{tikzplotly-0.1.3/src/tikzplotly.egg-info → tikzplotly-0.1.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tikzplotly
-Version: 0.1.3
+Version: 0.1.4
 Summary: Convert plotly figures to LaTeX / tikz figures
 Author-email: Thomas Saigre <tikzplotly@outlook.fr>
 License: The MIT License (MIT)
@@ -42,6 +42,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy
 Requires-Dist: plotly
+Requires-Dist: PIL
 Provides-Extra: dev
 Requires-Dist: pandas; extra == "dev"
 

{tikzplotly-0.1.3 → tikzplotly-0.1.4}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tikzplotly"
-version = "0.1.3"
+version = "0.1.4"
 description = "Convert plotly figures to LaTeX / tikz figures"
 readme = "README.md"
 authors = [{name = "Thomas Saigre", email = "tikzplotly@outlook.fr"}]
@@ -25,7 +25,8 @@ classifiers = [
 keywords = ["plotly", "latex", "tikz", "figure", "conversion", "graphics"]
 dependencies = [
     "numpy",
-    "plotly"
+    "plotly",
+    "PIL"
 ]
 
 [project.optional-dependencies]

tikzplotly-0.1.4/src/tests/test_heatmaps.py

@@ -0,0 +1,206 @@
+# From https://plotly.com/python/heatmaps/
+import os
+import tikzplotly
+
+from tikzplotly._tex import tex_create_document, tex_begin_environment, tex_end_environment, tex_end_all_environment
+
+import plotly
+import plotly.express as px
+import pandas as pd
+import plotly.graph_objects as go
+import numpy as np
+import datetime
+import numpy as np
+np.random.seed(1)
+
+def fig1():
+    fig = px.imshow([[1, 20, 30],
+                    [20, 1, 60],
+                    [30, 60, 1]])
+    # fig.show()
+    return fig, "Heatmaps with Plotly Express"
+
+def fig2():
+    df = px.data.medals_wide(indexed=True)
+    fig = px.imshow(df)
+    # fig.show()
+    return fig, "Heatmaps with Plotly Express 2"
+
+def fig3():
+    z = [[.1, .3, .5, .7, .9],
+        [1, .8, .6, .4, .2],
+        [.2, 0, .5, .7, .9],
+        [.9, .8, .4, .2, 0],
+        [.3, .4, .5, .7, 1]]
+
+    fig = px.imshow(z, text_auto=True)
+    # fig.show()
+    return fig, "Displaying Text on Heatmaps"
+
+def fig4():
+    z = [[.1, .3, .5, .7, .9],
+     [1, .8, .6, .4, .2],
+     [.2, 0, .5, .7, .9],
+     [.9, .8, .4, .2, 0],
+     [.3, .4, .5, .7, 1]]
+
+    fig = px.imshow(z, text_auto=True, aspect="auto")
+    # fig.show()
+    return fig, "Controlling Aspect Ratio"
+
+def fig5():
+    data=[[1, 25, 30, 50, 1], [20, 1, 60, 80, 30], [30, 60, 1, 5, 20]]
+    fig = px.imshow(data,
+                    labels=dict(x="Day of Week", y="Time of Day", color="Productivity"),
+                    x=['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'],
+                    y=['Morning', 'Afternoon', 'Evening']
+                )
+    fig.update_xaxes(side="top")
+    # fig.show()
+    return fig, "Customizing the axes and labels on a heatmap"
+
+def fig6():
+
+    fig = go.Figure(data=go.Heatmap(
+                        z=[[1, 20, 30],
+                        [20, 1, 60],
+                        [30, 60, 1]]))
+    # fig.show()
+    return fig, "Basic Heatmap with plotly.graph\\_objects"
+
+def fig7():
+    fig = go.Figure(data=go.Heatmap(
+                   z=[[1, None, 30, 50, 1], [20, 1, 60, 80, 30], [30, 60, 1, -10, 20]],
+                   x=['Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday'],
+                   y=['Morning', 'Afternoon', 'Evening'],
+                   hoverongaps = False))
+    # fig.show()
+    return fig, "Heatmap with Categorical Axis Labels"
+
+def fig8():
+    import plotly.graph_objects as go
+
+    # Build the rectangles as a heatmap
+    # specify the edges of the heatmap squares
+    phi = (1 + np.sqrt(5) )/2. # golden ratio
+    xe = [0, 1, 1+(1/(phi**4)), 1+(1/(phi**3)), phi]
+    ye = [0, 1/(phi**3), 1/phi**3+1/phi**4, 1/(phi**2), 1]
+
+    z = [ [13,3,3,5],
+        [13,2,1,5],
+        [13,10,11,12],
+        [13,8,8,8]
+        ]
+
+    fig = go.Figure(data=go.Heatmap(
+            x = np.sort(xe),
+            y = np.sort(ye),
+            z = z,
+            type = 'heatmap',
+            colorscale = 'Viridis'))
+
+    # Add spiral line plot
+
+    def spiral(th):
+        a = 1.120529
+        b = 0.306349
+        r = a*np.exp(-b*th)
+        return (r*np.cos(th), r*np.sin(th))
+
+    theta = np.linspace(-np.pi/13,4*np.pi,1000); # angle
+    (x,y) = spiral(theta)
+
+    fig.add_trace(go.Scatter(x= -x+x[0], y= y-y[0],
+        line =dict(color='white',width=3)))
+
+    axis_template = dict(range = [0,1.6], autorange = False,
+                showgrid = False, zeroline = False,
+                linecolor = 'black', showticklabels = False,
+                ticks = '' )
+
+    fig.update_layout(margin = dict(t=200,r=200,b=200,l=200),
+        xaxis = axis_template,
+        yaxis = axis_template,
+        showlegend = False,
+        width = 700, height = 700,
+        autosize = False )
+
+    # fig.show()
+    return fig, "Heatmap with Unequal Block Sizes"
+
+
+def fig9():
+    import plotly.graph_objects as go
+
+
+    programmers = ['Alex','Nicole','Sara','Etienne','Chelsea','Jody','Marianne']
+
+    base = datetime.datetime.today()
+    dates = base - np.arange(180) * datetime.timedelta(days=1)
+    z = np.random.poisson(size=(len(programmers), len(dates)))
+
+    fig = go.Figure(data=go.Heatmap(
+            z=z,
+            x=dates,
+            y=programmers,
+            colorscale='Viridis'))
+
+    fig.update_layout(
+        title='GitHub commits per day',
+        xaxis_nticks=36)
+
+    # fig.show()
+    return fig, "Heatmap with Datetime Axis"
+
+
+def fig11():    # from @JasonGross, see issue https://github.com/thomas-saigre/tikzplotly/issues/6
+    data = np.random.rand(10,10)
+    fig = px.imshow(data, color_continuous_scale='Viridis', title='Heatmap Example with Plotly Express')
+    # fig.show()
+    return fig, "Heatmap Example with Plotly Express"
+
+if __name__ == "__main__":
+
+    print("Tikzploty : ", tikzplotly.__version__)
+    print("Plotly : ", plotly.__version__)
+    print("Test line charts")
+
+    file_directory = os.path.dirname(os.path.abspath(__file__))
+
+    functions = [
+        ("1", fig1),
+        ("2", fig2),
+        # ("3", fig3),          # texttemplate not supported
+        ("4", fig4),
+        ("5", fig5),
+        ("6", fig6),
+        ("7", fig7),
+        # ("8", fig8),          # Not supported
+        ("9", fig9),
+        ("11", fig11)
+
+    ]
+
+    main_tex_content = tex_create_document(options="twocolumn", compatibility="newest")
+    main_tex_content += "\\usepackage[left=1cm, right=1cm, top=1cm, bottom=1cm]{geometry}\n"
+    main_tex_content += "\n"
+    stack_env = []
+    main_tex_content += tex_begin_environment("document", stack_env) + '\n'
+
+    for i, f in functions:
+        print(f"Figure {i}")
+        fig, title = f()
+        data = fig.data
+        save_path = os.path.join(file_directory, "outputs", "test_heatmap", "fig{}.tex".format(i))
+        tikzplotly.save(save_path, fig, img_name=os.path.join(file_directory, "outputs", "test_heatmap", "fig{}.png".format(i)))
+        main_tex_content += tex_begin_environment("figure", stack_env)
+        main_tex_content += "  \\input{fig" + str(i) + ".tex}\n"
+        main_tex_content += "  \\caption{" + title + "}\n"
+        main_tex_content += tex_end_environment(stack_env) + '\n'
+
+    main_tex_content += "\n" + tex_end_all_environment(stack_env)
+
+    main_tex_path = os.path.join(file_directory, "outputs", "test_heatmap", "main.tex")
+    print("Save main tex file : ", main_tex_path)
+    with open(main_tex_path, "w") as f:
+        f.write(main_tex_content)

tikzplotly-0.1.4/src/tikzplotly/__about__.py

@@ -0,0 +1 @@
+__version__ = "0.1.4"

{tikzplotly-0.1.3 → tikzplotly-0.1.4}/src/tikzplotly/_color.py

@@ -54,6 +54,22 @@ def convert_color(color):
         warn(f"Color {color} type is not supported yet. Returning the same color.")
         return color, 1
 
+def hex2rgb(hex_color):
+    """Convert a hex color to a RGB color.
+
+    Parameters
+    ----------
+    hex_color
+        hex color string
+
+    Returns
+    -------
+        RGB color string
+    """
+    hex_color = hex_color.lstrip("#")
+    return str(int(hex_color[:2], 16)) + ", " + str(int(hex_color[2:4], 16)) + ", " + str(int(hex_color[4:], 16))
+
+DEFAULT_COLORSCALE = ((0.0, '#0d0887'), (0.1111111111111111, '#46039f'), (0.2222222222222222, '#7201a8'), (0.3333333333333333, '#9c179e'), (0.4444444444444444, '#bd3786'), (0.5555555555555556, '#d8576b'), (0.6666666666666666, '#ed7953'), (0.7777777777777778, '#fb9f3a'), (0.8888888888888888, '#fdca26'), (1.0, '#f0f921'))
 
 
 ALICEBLUE = rgb_str(240, 248, 255)

{tikzplotly-0.1.3 → tikzplotly-0.1.4}/src/tikzplotly/_dataContainer.py

@@ -51,6 +51,8 @@ class DataContainer:
             tuple (macro_name, y_label), where macro_name is the name of the data in LaTeX and y_label the name of the y data in LaTeX
         """
         for data in self.data:
+            if len(data.x) != len(x):
+                continue
             are_equals = data.x == x
             if type(are_equals) == bool:
                 if are_equals:

tikzplotly-0.1.4/src/tikzplotly/_heatmap.py

@@ -0,0 +1,145 @@
+from copy import deepcopy
+import numpy as np
+import io
+from PIL import Image
+from warnings import warn
+from ._tex import tex_addplot, get_tikz_colorscale
+from ._axis import Axis
+from ._color import DEFAULT_COLORSCALE
+from ._utils import get_ticks_str
+
+def crop_image(img_data):
+    """Crops an image to the smallest bounding box that contains all non-white pixels.
+
+    Parameters
+    ----------
+    img_data
+        A PIL Image object.
+
+    Returns
+    -------
+        cropped_image : PIL Image
+    """
+    image_np = np.array(img_data)
+    non_white_rows = np.any(image_np != [255, 255, 255, 255], axis=1)
+    non_white_cols = np.any(image_np != [255, 255, 255, 255], axis=0)
+
+    top, bottom = np.where(non_white_rows)[0][[0, -1]]
+    left, right = np.where(non_white_cols)[0][[0, -1]]
+    cropped_image = Image.fromarray(image_np[top:bottom+1, left:right+1])
+
+    return cropped_image
+
+def resize_image(img, nb_row, nb_col):
+    """Resizes an image to a given number of rows and columns.
+
+    Parameters
+    ----------
+    img
+        A PIL Image object.
+    nb_row
+        The number of rows of the resized image.
+    nb_col
+        The number of columns of the resized image.
+
+    Returns
+    -------
+        resized_image : PIL Image
+    """
+    resized_image = Image.new("RGBA", size = (nb_col, nb_row))
+    block_size = (img.width // nb_col, img.height // nb_row)
+
+    if block_size[0] != img.width / nb_col or block_size[1] != img.height / nb_row:
+        warn("png image has not been reduced, see https://github.com/thomas-saigre/tikzplotly/issues/6#issuecomment-2106180586")
+        return img
+
+    for i in range(nb_row):
+        for j in range(nb_col):
+            color = img.getpixel((j * block_size[0], i * block_size[1]))
+            resized_image.putpixel((j, i), color)
+
+    return resized_image
+
+
+def draw_heatmap(data, fig, img_name, axis: Axis):
+    """Draw a heatmap, and return the tikz code.
+
+    Parameters
+    ----------
+    data
+        data array to be plotted
+    fig
+        whole plotly figure
+    img_name
+        name of the image file to be created
+    axis
+        axis object previously created
+
+    Returns
+    -------
+        string of tikz code for the scatter trace
+    """
+
+    code = ""
+
+    figure_data = np.array(data.z)
+
+    # We create a new figure with only the data, and export it as a png
+    fig_copy = deepcopy(fig)
+    fig_copy.update_layout(coloraxis_showscale=False, coloraxis_colorbar=None, xaxis_visible=False, yaxis_visible=False)
+    try:
+        fig_copy.update_traces(showscale=False)
+    except ValueError as e:
+        pass
+
+    if data.texttemplate is not None:
+        warn("Text template is not supported yet.")
+        fig_copy.update_traces(texttemplate=None)
+    fig_copy.update_layout(title=None)
+
+    img_bytes = fig_copy.to_image(format="png")  # The image created by plotly keeps places around the heatmap
+    cropped_image = crop_image(Image.open(io.BytesIO(img_bytes)))   # so we crop all the white around the figure
+    resized_image = resize_image(cropped_image, *figure_data.shape)  # and we resize it so each square is a 1px x 1px square
+    resized_image.save(img_name)
+
+
+    xmin = -0.5
+    xmax = -0.5 + figure_data.shape[1]
+    ymin = -0.5 + figure_data.shape[0]
+    ymax = -0.5         # NB : the axis is reversed
+
+
+    if not (fig.layout.coloraxis.showscale == False):   # If the value is True or None
+        axis.add_option("colorbar", None)
+
+    if (x := data.x) is not None:
+        xtick, xticklabels = get_ticks_str(x, fig.layout.xaxis.nticks)
+        axis.add_option("xtick", xtick)
+        axis.add_option("xticklabels", xticklabels)
+
+    if (y := data.y) is not None:
+        ytick, yticklabels = get_ticks_str(y, fig.layout.yaxis.nticks)
+        axis.add_option("ytick", ytick)
+        axis.add_option("yticklabels", yticklabels)
+
+    if (colorscale := data.colorscale) is not None:
+        axis.add_option("colormap", get_tikz_colorscale(colorscale))
+    elif (colorscale := fig.layout.coloraxis.colorscale) is not None:
+        axis.add_option("colormap", get_tikz_colorscale(colorscale))
+    elif data.showscale is not False:
+        warn("No colorscale found, using default")
+        axis.add_option("colormap", get_tikz_colorscale(DEFAULT_COLORSCALE))
+
+    tmp = np.where(figure_data == None, np.nan, figure_data)
+    axis.add_option("point meta max", tmp.max())
+    axis.add_option("point meta min", tmp.min())
+    axis.add_option("xmin", xmin)
+    axis.add_option("xmax", xmax)
+    axis.add_option("ymin", ymax)
+    axis.add_option("ymax", ymin)
+    axis.add_option("tick align", "outside")
+    axis.add_option("tick pos", "left")
+
+    code += tex_addplot(img_name, type="graphics", type_options=f"includegraphics cmd=\pgfimage,xmin={xmin}, xmax={xmax}, ymin={ymin}, ymax={ymax}")
+
+    return code

{tikzplotly-0.1.3 → tikzplotly-0.1.4}/src/tikzplotly/_save.py

@@ -2,6 +2,7 @@ from pathlib import Path
 from .__about__ import __version__
 from ._tex import *
 from ._scatter import draw_scatter2d
+from ._heatmap import draw_heatmap
 from ._axis import Axis
 from ._color import *
 from ._annotations import str_from_annotation
@@ -15,6 +16,7 @@ def get_tikz_code(
         tikz_options = None,
         axis_options = None,
         include_disclamer = True,
+        img_name = "heatmap.png",
     ):
     """Get the tikz code of a figure.
 
@@ -28,6 +30,8 @@ def get_tikz_code(
         options given to the axis environment, by default None
     include_disclamer, optional
         include a disclamer in the code, by default True
+    img_name, optional
+        name of the PNG file for heatmap, by default "heatmap.png"
 
     Returns
     -------
@@ -59,6 +63,10 @@ def get_tikz_code(
                 colors_set.add(convert_color(trace.line.color)[:3])
             if trace.fillcolor is not None:
                 colors_set.add(convert_color(trace.fillcolor)[:3])
+
+        elif trace.type == "heatmap":
+            data_str.append( draw_heatmap(trace, fig, img_name, axis) )
+
         else:
             warn(f"Trace type {trace.type} is not supported yet.")
 
@@ -110,5 +118,8 @@ def save(filepath: str | Path, *args, encoding: str | None = None, **kwargs):
         Additional arguments are passed to the backend.
     """
     code = get_tikz_code(*args, **kwargs)
+    directory = Path(filepath).parent
+    if not directory.exists():
+        directory.mkdir(parents=True)
     with open(filepath, "w") as fd:
         fd.write(code)

{tikzplotly-0.1.3 → tikzplotly-0.1.4}/src/tikzplotly/_tex.py

@@ -1,3 +1,4 @@
+from ._color import hex2rgb
 
 def tex_comment(text):
     """Create a LaTeX comment.
@@ -190,4 +191,13 @@ def tex_text(text):
     """Convert a string to LaTeX,
     escaping the special characters %, _, &, #, $, {, }, ~.
     """
-    return text.replace("%", "\\%").replace("_", "\\_").replace("&", "\\&").replace("#", "\\#").replace("$", "\\$").replace("{", "\\{").replace("}", "\\}").replace("~", "\\textasciitilde ")
+    return text.replace("%", "\\%").replace("_", "\\_").replace("&", "\\&").replace("#", "\\#").replace("$", "\\$").replace("{", "\\{").replace("}", "\\}").replace("~", "\\textasciitilde ")
+
+def get_tikz_colorscale(colorscale, name="mycolor"):
+
+    code = "{" + str(name) + "}{\n"
+    for dist, color in colorscale:
+        rgb_color = hex2rgb(color)
+        code += f"  rgb255({dist}cm)=({rgb_color})".replace(" ", "") + ";\n"
+    code += "}"
+    return code

{tikzplotly-0.1.3 → tikzplotly-0.1.4}/src/tikzplotly/_utils.py

@@ -1,6 +1,7 @@
 import re
 import warnings
 from math import floor
+import numpy as np
 
 rep_digit = {'0': 'Z', '1': 'O', '2': 'T', '3': 'Th', '4': 'F', '5': 'Fi', '6': 'S', '7': 'Se', '8': 'E', '9': 'N'}
 rep_digit = dict((re.escape(k), v) for k, v in rep_digit.items())
@@ -110,4 +111,22 @@ def option_dict_to_str(options_dict, sep=" "):
             options += f"{key}={value},{sep}"
     if options == "":
         return None
-    return options.strip()[:-1]
+    return options.strip()[:-1]
+
+def get_ticks_str(data, nticks):
+    indices = np.arange(len(data))
+    if nticks is not None:
+        data_ = data[::len(data)//(nticks-1)]
+        data = np.append(data_, [data[-1]])
+        indices_ = indices[::len(indices)//(nticks-1)]
+        indices = np.append(indices_, [indices[-1]])
+
+    ticks = "{"
+    ticklabels = "{"
+    for i, val in zip(indices, data):
+        ticks += str(i) + ","
+        ticklabels += str(val) + ","
+    ticks = ticks[:-1] + "}"
+    ticklabels = ticklabels[:-1] + "}"
+
+    return ticks, ticklabels

{tikzplotly-0.1.3 → tikzplotly-0.1.4/src/tikzplotly.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tikzplotly
-Version: 0.1.3
+Version: 0.1.4
 Summary: Convert plotly figures to LaTeX / tikz figures
 Author-email: Thomas Saigre <tikzplotly@outlook.fr>
 License: The MIT License (MIT)
@@ -42,6 +42,7 @@ Description-Content-Type: text/markdown
 License-File: LICENSE
 Requires-Dist: numpy
 Requires-Dist: plotly
+Requires-Dist: PIL
 Provides-Extra: dev
 Requires-Dist: pandas; extra == "dev"
 

{tikzplotly-0.1.3 → tikzplotly-0.1.4}/src/tikzplotly.egg-info/SOURCES.txt

@@ -1,6 +1,9 @@
 LICENSE
 README.md
 pyproject.toml
+src/tests/test_heatmaps.py
+src/tests/test_line_charts.py
+src/tests/test_markers.py
 src/tikzplotly/__about__.py
 src/tikzplotly/__init__.py
 src/tikzplotly/_annotations.py
@@ -9,6 +12,7 @@ src/tikzplotly/_color.py
 src/tikzplotly/_dash.py
 src/tikzplotly/_data.py
 src/tikzplotly/_dataContainer.py
+src/tikzplotly/_heatmap.py
 src/tikzplotly/_marker.py
 src/tikzplotly/_save.py
 src/tikzplotly/_scatter.py
@@ -18,6 +22,4 @@ src/tikzplotly.egg-info/PKG-INFO
 src/tikzplotly.egg-info/SOURCES.txt
 src/tikzplotly.egg-info/dependency_links.txt
 src/tikzplotly.egg-info/requires.txt
-src/tikzplotly.egg-info/top_level.txt
-tests/test_line_charts.py
-tests/test_markers.py
+src/tikzplotly.egg-info/top_level.txt

{tikzplotly-0.1.3 → tikzplotly-0.1.4}/src/tikzplotly.egg-info/requires.txt

@@ -1,5 +1,6 @@
 numpy
 plotly
+PIL
 
 [dev]
 pandas

{tikzplotly-0.1.3 → tikzplotly-0.1.4}/src/tikzplotly.egg-info/top_level.txt

@@ -1 +1,2 @@
+tests
 tikzplotly

tikzplotly-0.1.3/src/tikzplotly/__about__.py

@@ -1 +0,0 @@
-__version__ = "0.1.3"