Debian Codegraph @

texmf-dist/doc/latex/tikz-network/README.md

raw
1 # tikz-network - A tool to visualize complex networks in LaTeX.
2
3 ## Summary
4
5 **tikz-network** is an open source software project for visualizing graphs and
6 networks in LaTeX. It aims to provide a simple and easy tool to create,
7 visualize and modify complex networks. The packaged is based on the PGF/TikZ
8 languages for producing vector graphics from a geometric/algebraic
9 description. Particular focus is made on the software usability and
10 interoperability with other tools. Simple networks can be directly created
11 within LaTeX, while more complex networks can be imported from external
12 sources (e.g. igraph, networkx, QGIS, ...). Additionally, **tikz-network**
13 supports visualization of multilayer networks in two and three dimensions.
14
15 ## Purpose
16
17 In recent years, complex network theory becomes more and more popular within the
18 scientific community. Besides a solid mathematical base on which these theories
19 are built on, a visual representation of the networks allow communicating
20 complex relationships to a broad audience.
21
22 Nowadays, a variety of great visualization tools are available, which helps to
23 structure, filter, manipulate and of course to visualize the networks. However,
24 they come with some limitations, including the need for specific software tools,
25 difficulties to embed the outputs properly in a LaTeX file (e.g. font type,
26 font size, additional equations and math symbols needed,...) and challenges
27 in the post-processing of the graphs, without rerunning the software tools
28 again.
29
30 In order to overcome this issues, the package **tikz-network*** was
31 created. Since LaTeX is a standard for scientific publications and widely
32 used, there is a high chance that users are already familiar with the syntax and
33 the structure of this language. Beside LaTeX, no other software tool is
34 needed. The commands of **tikz-network** are kept simple but allow a high
35 control over the produced output. Post-processing of the network (e.g. adding
36 drawings, images, texts, equations,...) can be done easily, due to the
37 compatibility with PGF/TikZ (Tantau 2015). Also, the embedding of
38 the network visualization into the LaTeX-environment enables the use of the
39 fonts, font sizes, mathematical symbols, hyperlinks, references,..., as used
40 in the document. Additional features are the three-dimensional visualization of
41 (multilayer) networks, and the compatible with other layout and visualization
42 tools (e.g. igraph, netwrokx, QGIS, ...).
43
44 ## Additional information and examples
45
46 - The usage of the package is documented in the
47 [manual](https://github.com/hackl/tikz-network/blob/master/manual.pdf)
48 ([arXiv](https://arxiv.org/pdf/1709.06005.pdf)).
49 - The current developer version of the package is available on
50 [GitHub](https://github.com/hackl/tikz-network).
51 - [There](https://github.com/hackl/tikz-network/tree/master/examples), also
52 additional (more complex) examples can be found.
53 - To convert networks from Python into TikZ an API for the package is available
54 under <https://pypi.org/project/network2tikz/> or
55 <https://github.com/hackl/network2tikz>
56
57 ## License
58
59 Copyright (c) 2019 [Juergen Hackl](mailto:[email protected])
60
61 This program is free software: you can redistribute it and/or modify it under
62 the terms of the GNU General Public License as published by the Free Software
63 Foundation, either version 3 of the License, or (at your option) any later
64 version.
65
66 This program is distributed in the hope that it will be useful, but WITHOUT ANY
67 WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A
68 PARTICULAR PURPOSE. See the GNU General Public License for more details.
69
70 You should have received a copy of the GNU General Public License along with
71 this program. If not, see <http://www.gnu.org/licenses/>.