Skip to content

core

TikzPlot

Bases: pathpyG.visualisations.plot.PathPyPlot

Base class for plotting d3js objects.

Source code in src/pathpyG/visualisations/_tikz/core.py 
 30
 31
 32
 33
 34
 35
 36
 37
 38
 39
 40
 41
 42
 43
 44
 45
 46
 47
 48
 49
 50
 51
 52
 53
 54
 55
 56
 57
 58
 59
 60
 61
 62
 63
 64
 65
 66
 67
 68
 69
 70
 71
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
class TikzPlot(PathPyPlot):
    """Base class for plotting d3js objects."""

    def __init__(self, **kwargs: Any) -> None:
        """Initialize plot class."""
        super().__init__()
        if kwargs:
            self.config = kwargs

    def generate(self) -> None:
        """Generate the plot."""
        raise NotImplementedError

    def save(self, filename: str, **kwargs: Any) -> None:
        """Save the plot to the hard drive."""
        if filename.endswith("tex"):
            with open(filename, "w+") as new:
                new.write(self.to_tex())
        elif filename.endswith("pdf"):
            # compile temporary pdf
            temp_file, temp_dir = self.compile_pdf()
            # Copy a file with new name
            shutil.copy(temp_file, filename)
            # remove the temporal directory
            shutil.rmtree(temp_dir)

        else:
            raise NotImplementedError

    def show(self, **kwargs: Any) -> None:
        """Show the plot on the device."""
        # compile temporary pdf
        temp_file, temp_dir = self.compile_pdf()

        if config["environment"]["interactive"]:
            from IPython.display import IFrame, display

            # open the file in the notebook
            display(IFrame(temp_file, width=600, height=300))
        else:
            # open the file in the webbrowser
            webbrowser.open(r"file:///" + temp_file)

        # Wait for .1 second before temp file is deleted
        time.sleep(0.1)

        # remove the temporal directory
        shutil.rmtree(temp_dir)

    def compile_pdf(self) -> tuple:
        """Compile pdf from tex."""
        # basename
        basename = "default"
        # get current directory
        current_dir = os.getcwd()

        # template directory
        tikz_dir = str(
            os.path.join(
                os.path.dirname(os.path.dirname(__file__)),
                os.path.normpath("templates"),
                "tikz-network.sty",
            )
        )

        # get temporal directory
        temp_dir = tempfile.mkdtemp()

        # copy tikz-network to temporal directory
        shutil.copy(tikz_dir, temp_dir)

        # change to output dir
        os.chdir(temp_dir)

        # save the tex file
        self.save(basename + ".tex")

        # latex compiler
        command = [
            "latexmk",
            "--pdf",
            "-shell-escape",
            "--interaction=nonstopmode",
            basename + ".tex",
        ]

        try:
            subprocess.check_output(command, stderr=subprocess.STDOUT)
        except Exception:
            # If compiler does not exist, try next in the list
            logger.error("No latexmk compiler found")
            raise AttributeError
        finally:
            # change back to the current directory
            os.chdir(current_dir)

        # return the name of the folder and temp pdf file
        return (os.path.join(temp_dir, basename + ".pdf"), temp_dir)

    def to_tex(self) -> str:
        """Convert data to tex."""
        # get path to the pathpy templates
        template_dir = os.path.join(
            os.path.dirname(os.path.dirname(__file__)),
            os.path.normpath("_tikz/templates"),
        )

        # get template files
        with open(os.path.join(template_dir, f"{self._kind}.tex")) as template:
            tex_template = template.read()

        # generate data
        data = self.to_tikz()

        # fill template with data
        tex = Template(tex_template).substitute(
            classoptions=self.config.get("latex_class_options", ""),
            width=self.config.get("width", "6cm"),
            height=self.config.get("height", "6cm"),
            tikz=data,
        )

        return tex

    def to_tikz(self) -> str:
        """Convert data to tikz."""
        raise NotImplementedError

__init__

Initialize plot class.

Source code in src/pathpyG/visualisations/_tikz/core.py 
33
34
35
36
37
def __init__(self, **kwargs: Any) -> None:
    """Initialize plot class."""
    super().__init__()
    if kwargs:
        self.config = kwargs

compile_pdf

Compile pdf from tex.

Source code in src/pathpyG/visualisations/_tikz/core.py 
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
def compile_pdf(self) -> tuple:
    """Compile pdf from tex."""
    # basename
    basename = "default"
    # get current directory
    current_dir = os.getcwd()

    # template directory
    tikz_dir = str(
        os.path.join(
            os.path.dirname(os.path.dirname(__file__)),
            os.path.normpath("templates"),
            "tikz-network.sty",
        )
    )

    # get temporal directory
    temp_dir = tempfile.mkdtemp()

    # copy tikz-network to temporal directory
    shutil.copy(tikz_dir, temp_dir)

    # change to output dir
    os.chdir(temp_dir)

    # save the tex file
    self.save(basename + ".tex")

    # latex compiler
    command = [
        "latexmk",
        "--pdf",
        "-shell-escape",
        "--interaction=nonstopmode",
        basename + ".tex",
    ]

    try:
        subprocess.check_output(command, stderr=subprocess.STDOUT)
    except Exception:
        # If compiler does not exist, try next in the list
        logger.error("No latexmk compiler found")
        raise AttributeError
    finally:
        # change back to the current directory
        os.chdir(current_dir)

    # return the name of the folder and temp pdf file
    return (os.path.join(temp_dir, basename + ".pdf"), temp_dir)

generate

Generate the plot.

Source code in src/pathpyG/visualisations/_tikz/core.py 
39
40
41
def generate(self) -> None:
    """Generate the plot."""
    raise NotImplementedError

save

Save the plot to the hard drive.

Source code in src/pathpyG/visualisations/_tikz/core.py 
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
def save(self, filename: str, **kwargs: Any) -> None:
    """Save the plot to the hard drive."""
    if filename.endswith("tex"):
        with open(filename, "w+") as new:
            new.write(self.to_tex())
    elif filename.endswith("pdf"):
        # compile temporary pdf
        temp_file, temp_dir = self.compile_pdf()
        # Copy a file with new name
        shutil.copy(temp_file, filename)
        # remove the temporal directory
        shutil.rmtree(temp_dir)

    else:
        raise NotImplementedError

show

Show the plot on the device.

Source code in src/pathpyG/visualisations/_tikz/core.py 
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
def show(self, **kwargs: Any) -> None:
    """Show the plot on the device."""
    # compile temporary pdf
    temp_file, temp_dir = self.compile_pdf()

    if config["environment"]["interactive"]:
        from IPython.display import IFrame, display

        # open the file in the notebook
        display(IFrame(temp_file, width=600, height=300))
    else:
        # open the file in the webbrowser
        webbrowser.open(r"file:///" + temp_file)

    # Wait for .1 second before temp file is deleted
    time.sleep(0.1)

    # remove the temporal directory
    shutil.rmtree(temp_dir)

to_tex

Convert data to tex.

Source code in src/pathpyG/visualisations/_tikz/core.py 
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
def to_tex(self) -> str:
    """Convert data to tex."""
    # get path to the pathpy templates
    template_dir = os.path.join(
        os.path.dirname(os.path.dirname(__file__)),
        os.path.normpath("_tikz/templates"),
    )

    # get template files
    with open(os.path.join(template_dir, f"{self._kind}.tex")) as template:
        tex_template = template.read()

    # generate data
    data = self.to_tikz()

    # fill template with data
    tex = Template(tex_template).substitute(
        classoptions=self.config.get("latex_class_options", ""),
        width=self.config.get("width", "6cm"),
        height=self.config.get("height", "6cm"),
        tikz=data,
    )

    return tex

to_tikz

Convert data to tikz.

Source code in src/pathpyG/visualisations/_tikz/core.py 
154
155
156
def to_tikz(self) -> str:
    """Convert data to tikz."""
    raise NotImplementedError