tikzplotly 0.1.2__tar.gz → 0.1.4__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: tikzplotly
-Version: 0.1.2
+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"
 
@@ -140,6 +141,7 @@ To correctly compile the document, you will need to add the following packages t
 * This module is in development and new features are added bit by bit, when needed. If you have a feature request, please open an issue with the plotly figure you want to convert and the desired output.
 You can also submit a pull request with the desired feature !
 * Some feature can result in different output between the plotly figure and the tikz figure, for instance the size of markers.
+* More details in [doc/NB.md](doc/NB.md).
 
 
 ## References

{tikzplotly-0.1.2 → tikzplotly-0.1.4}/README.md

@@ -93,6 +93,7 @@ To correctly compile the document, you will need to add the following packages t
 * This module is in development and new features are added bit by bit, when needed. If you have a feature request, please open an issue with the plotly figure you want to convert and the desired output.
 You can also submit a pull request with the desired feature !
 * Some feature can result in different output between the plotly figure and the tikz figure, for instance the size of markers.
+* More details in [doc/NB.md](doc/NB.md).
 
 
 ## References

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

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tikzplotly"
-version = "0.1.2"
+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/tests/test_markers.py

@@ -0,0 +1,392 @@
+# From https://plotly.com/python/marker-style/
+import plotly
+import plotly.express as px
+import pandas as pd
+import plotly.graph_objects as go
+import numpy as np
+import tikzplotly
+import os
+import plotly.graph_objects as go
+from plotly.validators.scatter.marker import SymbolValidator
+from warnings import warn
+from tikzplotly._tex import tex_create_document, tex_begin_environment, tex_end_environment, tex_end_all_environment
+
+def fig1():
+
+    df = px.data.iris()
+    fig = px.scatter(df, x="sepal_width", y="sepal_length", color="species")
+
+    fig.update_traces(marker=dict(size=12,
+                              line=dict(width=2,
+                                        color='DarkSlateGrey')),
+                  selector=dict(mode='markers'))
+    # fig.show()
+
+    return fig, "add marker border"
+
+def fig2():
+    np.random.seed(1)
+
+    x = np.random.uniform(low=3, high=6, size=(500,))
+    y = np.random.uniform(low=3, high=6, size=(500,))
+
+    # Build figure
+    fig = go.Figure()
+
+    # Add scatter trace with medium sized markers
+    fig.add_trace(
+        go.Scatter(
+            mode='markers',
+            x=x,
+            y=y,
+            marker=dict(
+                color='LightSkyBlue',
+                size=20,
+                line=dict(
+                    color='MediumPurple',
+                    width=2
+                )
+            ),
+            showlegend=False
+        )
+    )
+
+    # Add trace with large marker
+    fig.add_trace(
+        go.Scatter(
+            mode='markers',
+            x=[2],
+            y=[4.5],
+            marker=dict(
+                color='LightSkyBlue',
+                size=120,
+                line=dict(
+                    color='MediumPurple',
+                    width=12
+                )
+            ),
+            showlegend=False
+        )
+    )
+
+    return fig, "Add marker border 2"
+
+
+def fig3():
+    x = np.random.uniform(low=3, high=6, size=(500,))
+    y = np.random.uniform(low=3, high=4.5, size=(500,))
+    x2 = np.random.uniform(low=3, high=6, size=(500,))
+    y2 = np.random.uniform(low=4.5, high=6, size=(500,))
+
+    # Build figure
+    fig = go.Figure()
+
+    # Add first scatter trace with medium sized markers
+    fig.add_trace(
+        go.Scatter(
+            mode='markers',
+            x=x,
+            y=y,
+            opacity=0.5,
+            marker=dict(
+                color='LightSkyBlue',
+                size=3,
+                line=dict(color='MediumPurple')
+            ),
+            name='Opacity 0.5'
+        )
+    )
+
+    # Add second scatter trace with medium sized markers
+    # and opacity 1.0
+    fig.add_trace(
+        go.Scatter(
+            mode='markers',
+            x=x2,
+            y=y2,
+            marker=dict(
+                color='LightSkyBlue',
+                size=3,
+                line=dict(color='MediumPurple')
+            ),
+            name='Opacity 1.0'
+        )
+    )
+
+    # Add trace with large markers
+    fig.add_trace(
+        go.Scatter(
+            mode='markers',
+            x=[2, 2],
+            y=[4.25, 4.75],
+            marker=dict(
+                opacity=0.5,
+                color='LightSkyBlue',
+                size=10,
+                line=dict(color='MediumPurple')
+            ),
+            showlegend=False
+        )
+    )
+
+    return fig, "Opacity"
+
+def fig3bis():
+    x = np.random.uniform(low=3, high=6, size=(500,))
+    y = np.random.uniform(low=3, high=6, size=(500,))
+
+    # Build figure
+    fig = go.Figure()
+
+    # Add scatter trace with medium sized markers
+    fig.add_trace(
+        go.Scatter(
+            mode='markers',
+            x=x,
+            y=y,
+            marker=dict(
+                color='LightSkyBlue',
+                size=20,
+                opacity=0.5,
+                line=dict(
+                    color='MediumPurple',
+                    width=2
+                )
+            ),
+            showlegend=False
+        )
+    )
+
+
+    # Add trace with large markers
+    fig.add_trace(
+        go.Scatter(
+            mode='markers',
+            x=[2, 2],
+            y=[4.25, 4.75],
+            marker=dict(
+                color='LightSkyBlue',
+                size=80,
+                opacity=0.5,
+                line=dict(
+                    color='MediumPurple',
+                    width=8
+                )
+            ),
+            showlegend=False
+        )
+    )
+
+    return fig, "Marker Opacity"
+
+def fig3ter():
+    x = np.random.uniform(low=3, high=6, size=(500,))
+    y = np.random.uniform(low=3, high=6, size=(500,))
+
+
+    # Build figure
+    fig = go.Figure()
+
+    # Add scatter trace with medium sized markers
+    fig.add_trace(
+        go.Scatter(
+            mode='markers',
+            x=x,
+            y=y,
+            marker=dict(
+                color='rgba(135, 206, 250, 0.5)',
+                size=20,
+                line=dict(
+                    color='MediumPurple',
+                    width=2
+                )
+            ),
+            showlegend=False
+        )
+    )
+
+
+    # Add trace with large markers
+    fig.add_trace(
+        go.Scatter(
+            mode='markers',
+            x=[2, 2],
+            y=[4.25, 4.75],
+            marker=dict(
+                color='rgba(135, 206, 250, 0.5)',
+                size=80,
+                line=dict(
+                    color='MediumPurple',
+                    width=8
+                )
+            ),
+            showlegend=False
+        )
+    )
+    return fig, "Color opacity"
+
+def fig4():
+    warn("This example is not exactly the one online, but has been changed as this kind of data is not yet supported.")
+    raw_symbols = SymbolValidator().values
+    namestems = []
+    namevariants = []
+    symbols = []
+    names = []
+    for i in range(0, len(raw_symbols), 3):
+        name = raw_symbols[i+2]
+        symbols.append(raw_symbols[i])
+        namestems.append(name.replace("-open", "").replace("-dot", ""))
+        namevariants.append(name[len(namestems[-1]):])
+        names.append(name)
+
+    fig = go.Figure()
+
+    i = 0
+
+    names = ["circle", "square", "diamond", "cross", "x", "triangle-up", "triangle-down", "triangle-left", "triangle-right", "triangle-ne", "triangle-se", "triangle-sw", "triangle-nw", "pentagon", "hexagon", "hexagon2", "octagon", "star", "hexagram", "star-triangle-up", "star-triangle-down", "star-square", "star-diamond", "diamond-tall", "diamond-wide", "hourglass", "bowtie", "circle-cross", "circle-x", "square-cross", "square-x", "diamond-cross", "diamond-x", "cross-thin", "x-thin", "asterisk", "hash", "y-up", "y-down", "y-left", "y-right", "line-ew", "line-ns", "line-ne", "line-nw", "arrow-up", "arrow-down", "arrow-left", "arrow-right", "arrow-bar-up", "arrow-bar-down", "arrow-bar-left", "arrow-bar-right", "arrow", "arrow-wide"]
+    types = ["", "-open"]
+    for name in names:
+        for type in types:
+            name = name + type
+            fig.add_trace(go.Scatter(mode="markers", x=[i%2], y=[-(i//2)], marker_symbol=name,
+                                     marker_line_color="midnightblue", marker_color="lightskyblue",
+                                     marker_line_width=2, marker_size=8,
+                                     showlegend=False,
+                                     hovertemplate="name: %{y}%{x}<br>number: %{marker.symbol}<extra></extra>"))
+            i += 1
+
+    fig.update_layout(
+        xaxis=dict(
+            tickmode='array',
+            tickvals=[0, 1],
+            ticktext=types
+        ),
+        yaxis=dict(
+            tickmode='array',
+            tickvals=list(range(0, -55, -1)),
+            ticktext=names
+        )
+    )
+
+    # fig.show()
+    return fig, "Custom Marker Symbols"
+
+
+def fig5():
+    df = px.data.iris()
+    fig = px.scatter(df, x="sepal_width", y="sepal_length", color="species")
+
+    fig.update_traces(
+        marker=dict(size=8, symbol="diamond", line=dict(width=2, color="DarkSlateGrey")),
+        selector=dict(mode="markers"),
+    )
+
+    return fig, "Using a custom marker "
+
+def fig6():
+    df = px.data.iris()
+    fig = px.scatter(df, x="sepal_width", y="sepal_length", color="species")
+
+    fig.update_traces(
+        marker=dict(
+            size=8,
+            symbol="diamond-open",
+            line=dict(
+                width=2,
+    #             color="DarkSlateGrey" Line colors don't apply to open markers
+            )
+        ),
+        selector=dict(mode="markers"),
+    )
+    return fig, "Open Marker Colors"
+
+
+def fig7():
+    df = px.data.iris()
+    fig = px.scatter(df, x="sepal_width", y="sepal_length", color="species")
+
+    fig.update_traces(
+        marker=dict(
+            size=12, symbol="triangle-up", angle=45, line=dict(width=2, color="DarkSlateGrey")
+        ),
+        selector=dict(mode="markers"),
+    )
+    return fig, "Setting marker angle"
+
+def fig8():
+    df = px.data.gapminder()
+    fig = go.Figure()
+
+    for x in df.loc[df.continent.isin(["Europe"])].country.unique()[:5]:
+        fil = df.loc[(df.country.str.contains(x))]
+        fig.add_trace(
+            go.Scatter(
+                x=fil["year"],
+                y=fil["pop"],
+                mode="lines+markers",
+                marker=dict(
+                    symbol="arrow",
+                    size=15,
+                    angleref="previous",
+                ),
+                name=x,
+            )
+        )
+    return fig, "Setting Angle Reference"
+
+
+
+if __name__ == "__main__":
+
+    print("Tikzploty : ", tikzplotly.__version__)
+    print("Plotly : ", plotly.__version__)
+    print("Test markers")
+
+
+    file_directory = os.path.dirname(os.path.abspath(__file__))
+
+    functions = [
+        ("1", fig1),
+        ("2", fig2),
+        ("3", fig3),
+        ("3bis", fig3bis),
+        # ("3ter", fig3ter),
+        ("5", fig5),
+        ("6", fig6),
+        ("7", fig7),
+        # ("8", fig8),      # angle reference not supported yet
+    ]
+
+    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_markers", "fig{}.tex".format(i))
+        tikzplotly.save(save_path, fig)
+        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_markers", "main.tex")
+    print("Save main tex file : ", main_tex_path)
+    with open(main_tex_path, "w") as f:
+        f.write(main_tex_content)
+
+    ## Separately handling the case with all markers types
+    tex_markers = tex_create_document(document_class="standalone")
+    tex_markers += tex_begin_environment("document", stack_env) + '\n'
+    fig, title = fig4()
+    tikzplotly.save(os.path.join(file_directory, "outputs", "test_markers", "markers_fig.tex"), fig, axis_options="height=35cm, ymajorgrids, width=5cm")
+    tex_markers += "\\input{markers_fig.tex}\n"
+    tex_markers += tex_end_all_environment(stack_env)
+    with open(os.path.join(file_directory, "outputs", "test_markers", "markers.tex"), "w") as f:
+        f.write(tex_markers)

tikzplotly-0.1.4/src/tikzplotly/__about__.py

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