adding method tikz to class Graph #38798

seblabbe · 2024-10-10T13:14:46Z

Currently, we can create a TikzPicture from a graph as follows, but is raises an experimental feature warning:

sage: from sage.misc.latex_standalone import TikzPicture
sage: g = graphs.PetersenGraph()
sage: t = TikzPicture.from_graph(g)
<ipython-input-20-c4b6306d5e76>:1: FutureWarning: This class/method/function is marked as experimental. It, its functionality or its interface might change without a formal deprecation.
See https://github.com/sagemath/sage/issues/20343 for details.
  t = TikzPicture.from_graph(g)
sage: t

It was declared experimental during the review of #20343 because it should rather be a method of the class Graph.

This is what we do in this PR: we add a tikz method to the class Graph.

📝 Checklist

The title is concise and informative.
The description explains in detail what this PR is about.
I have linked a relevant issue or discussion.
I have created tests covering the changes.
I have updated the documentation
and checked the documentation preview.

⌛ Dependencies

None

Screenshots

As a consequence, the following now works in Jupyter. By default, it uses the dot2tex format if dot2tex is available:

Works well with sagetex

For example:

\begin{sagesilent}
g = graphs.PetersenGraph()
tikz = g.tikz()
\end{sagesilent}

\begin{center}
        \sageplot[scale=.5][pdf]{tikz}
\end{center}

github-actions · 2024-10-10T14:01:55Z

Documentation preview for this PR (built with commit 2a5b4d7; changes) is ready! 🎉
This preview will update shortly after each push to this PR.

src/sage/graphs/generic_graph.py

dcoudert

I tested it and it is a nice addition.

src/sage/graphs/generic_graph.py

…in set_options method already

dcoudert

This is much better and the examples are very nice (on my laptop).

dcoudert · 2024-10-18T09:55:15Z

src/sage/graphs/generic_graph.py

+        - ``rankdir`` -- string (default: ``'down'``), direction of graph layout
+          when prog is ``'dot'``, possible values are  ``'down'``,
+          ``'up'``, ``'right'`` and ``'left'``.
+        - ``subgraph_clusters`` -- (default: ``[]``) a list of lists of


default is None, not []. The same for other parameters.

None gets replaced by []. This is why I write that the default is []. I don't set the default argument to the empty list due to the gotcha related to doing this (https://docs.python-guide.org/writing/gotchas/).

If you insist that I replace [] by None and that I add a sentence after saying that None gets replaced by [], then I can.

src/sage/graphs/generic_graph.py

fchapoton · 2024-10-18T13:11:34Z

the linter is not happy, please fix the offending line

…ise, they get broken...)

dcoudert

LGTM.

seblabbe · 2024-10-18T16:22:46Z

Si j'ai ajouté Xavier comme reviewer, c'était pas pour mettre de la pression. C'est que j'étais dans son bureau et qu'il était curieux de tester aussi. Dans tous les cas, merci pour la relecture!

dcoudert · 2024-10-18T16:25:44Z

Pas de souci, et il ne faut pas qu'il hésite à revenir en arrière si il trouve qu'un truc ne va pas.

xcaruso · 2024-10-18T17:07:15Z

Non, tout va bien, c'est parfait.

Currently, we can create a TikzPicture from a graph as follows, but is raises an experimental feature warning: ``` sage: from sage.misc.latex_standalone import TikzPicture sage: g = graphs.PetersenGraph() sage: t = TikzPicture.from_graph(g) <ipython-input-20-c4b6306d5e76>:1: FutureWarning: This class/method/function is marked as experimental. It, its functionality or its interface might change without a formal deprecation. See sagemath#20343 for details. t = TikzPicture.from_graph(g) sage: t ``` It was declared experimental during the review of sagemath#20343 because it should rather be a method of the class Graph. This is what we do in this PR: we add a tikz method to the class Graph. ### 📝 Checklist  - [x] The title is concise and informative. - [x] The description explains in detail what this PR is about. - [x] I have linked a relevant issue or discussion. - [x] I have created tests covering the changes. - [x] I have updated the documentation - [ ] and checked the documentation preview. ### ⌛ Dependencies None ### Screenshots As a consequence, the following now works in Jupyter. By default, it uses the dot2tex format if dot2tex is available: ![image](https://github.com/user-attachments/assets/ff3c1ffb-46ae-46bf- bf64-f26cc3f93941) URL: sagemath#38798 Reported by: Sébastien Labbé Reviewer(s): David Coudert, Frédéric Chapoton, Sébastien Labbé, Xavier Caruso

tikz method for graphs was recently added in sagemath#38798 default value for `format` should be `None` as documented. ### ⌛ Dependencies sagemath#38798 URL: sagemath#38847 Reported by: Sébastien Labbé Reviewer(s): David Coudert, Frédéric Chapoton

github-actions bot added the s: needs review label Oct 10, 2024

adding method tikz to class Graph

24c4e9c

seblabbe force-pushed the graph_tikz_method branch from ac7cb63 to 24c4e9c Compare October 10, 2024 15:15

fchapoton reviewed Oct 10, 2024

View reviewed changes

src/sage/graphs/generic_graph.py Show resolved Hide resolved

unindent output line + added an item in the header doc

ba59952

dcoudert suggested changes Oct 12, 2024

View reviewed changes

seblabbe requested a review from xcaruso October 17, 2024 09:46

seblabbe added 5 commits October 17, 2024 11:55

PR sagemath#38798: add possible values for rankdir

28fe8db

PR sagemath#38798: expanded documentation for argument

f306705

PR sagemath#38798: add documentation for all possible options

f68b846

PR sagemath#38798: add missing dependency on amstext usepackage

f49902d

PR sagemath#38798: do not check for format value, since this is done …

026fd93

…in set_options method already

dcoudert suggested changes Oct 18, 2024

View reviewed changes

seblabbe added 3 commits October 18, 2024 15:20

PR sagemath#38798: removed unnecessary empty line

4fb2d5d

PR sagemath#38798: updated doctests tags (let's test them all, otherw…

486cec1

…ise, they get broken...)

PR sagemath#38798: fixing warning

2a5b4d7

dcoudert approved these changes Oct 18, 2024

View reviewed changes

dcoudert added s: positive review and removed s: needs review labels Oct 18, 2024

xcaruso approved these changes Oct 18, 2024

View reviewed changes

This was referenced Oct 24, 2024

Graph tikz method fixup #38847

Merged

Adding a tikz method to FinitePoset class #38848

Open

vbraun merged commit 05c92eb into sagemath:develop Oct 26, 2024
19 of 21 checks passed

github-actions bot removed the s: positive review label Oct 26, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

adding method tikz to class Graph #38798

adding method tikz to class Graph #38798

seblabbe commented Oct 10, 2024 •

edited

Loading

github-actions bot commented Oct 10, 2024 •

edited

Loading

dcoudert left a comment

dcoudert left a comment

dcoudert Oct 18, 2024

seblabbe Oct 18, 2024

fchapoton commented Oct 18, 2024

dcoudert left a comment

seblabbe commented Oct 18, 2024

dcoudert commented Oct 18, 2024

xcaruso commented Oct 18, 2024

adding method tikz to class Graph #38798

adding method tikz to class Graph #38798

Conversation

seblabbe commented Oct 10, 2024 • edited Loading

📝 Checklist

⌛ Dependencies

Screenshots

Works well with sagetex

github-actions bot commented Oct 10, 2024 • edited Loading

dcoudert left a comment

Choose a reason for hiding this comment

dcoudert left a comment

Choose a reason for hiding this comment

dcoudert Oct 18, 2024

Choose a reason for hiding this comment

seblabbe Oct 18, 2024

Choose a reason for hiding this comment

fchapoton commented Oct 18, 2024

dcoudert left a comment

Choose a reason for hiding this comment

seblabbe commented Oct 18, 2024

dcoudert commented Oct 18, 2024

xcaruso commented Oct 18, 2024

seblabbe commented Oct 10, 2024 •

edited

Loading

github-actions bot commented Oct 10, 2024 •

edited

Loading