Put manpage in right place - really, this time
[cluster-algebra-visualize.git] / cluster-algebra-visualize.1
blobb19333cd1399494bc1f5d0d7c43d998d2904a33c
1 .Dd 2016-06-01
2 .Dt CLUSTER-ALGEBRA-VISUALIZE 1
3 .Os
4 .Sh NAME
5 .Nm cluster-algebra-visualize
6 .Nd displays, and allows mutation of, cluster algebras in an ncurses display
7 .Sh SYNOPSIS
8 .Nm
9 .Oo
10 .Ar input-file
11 .Oc
12 .Sh DESCRIPTION
14 .Em cluster algebra
15 is a collection of
16 .Em quivers
17 which may be
18 .Em mutated
19 into one another. A
20 .Em quiver
21 may be visualized as a collection of vertices and arrows between the
22 vertices. The arrows have direction and multiplicity, and there cannot
23 be two different arrows between the same two vertices
24 .Pq even if the arrows are reversed .
25 .Pp
26 Cluster algebras come with an operation called
27 .Em mutation .
28 To mutate a quiver at a particular vertex
29 .Ar v ,
30 consider every
31 .Pq distinct
32 pair of vertices
33 .Ar t
34 and
35 .Ar u
36 which both have arrows
37 .Po call them, say,
38 .Ar e
39 and
40 .Ar f
41 respectively
42 .Pc
43 between them and
44 .Ar v .
46 .Ar e
47 points towards
48 .Ar v
49 and
50 .Ar f
51 points away from
52 .Ar v ,
53 then add a new arrow from
54 .Ar t
56 .Ar u
57 with multiplicity as the product of the multiplicities of
58 .Ar e
59 and
60 .Ar f
61 .Pq if an arrow is already present, just add to its multiplicity .
62 Once this has been done for all possible pairs (
63 .Ar t ,
64 .Ar u
65 ), reverse the multiplicity
66 .Pq reverse the direction
67 of all arrows touching
68 .Ar v .
69 .Pp
70 This operation is rather tedious when the arrows become numerous, so
71 .Nm
72 does it for you.
73 .Sh CREATING
74 To begin, run
75 .Nm ,
76 which will show a blank screen.  Press
77 .Ql p
78 to create a new point: move by using h/j/k/l or the arrow keys, pressing
79 .Ql Enter
80 to select that position. If you wish to create a shape which is larger
81 than the display allows, use h/j/k/l to scroll the viewport. Add
82 arrows between points by pressing
83 .Ql a
84 and entering the numbers of points. Pressing
85 .Ql s
86 and providing a filename will save the current state to that file, and
87 running
88 .Nm
89 later with that filename as the
90 .Ar input-name
91 argument will load the state where you left off.
92 .Sh MUTATING
93 Perform mutation by pressing
94 .Ql m
95 and entering a list of
96 .Pq whitespace-separated
97 point-names. Mutation will be performed at each of the points in
98 order. For example, running
99 .Pp
100 .D1 % cluster-algebra-visualize /usr/share/cluster-algebra-visualize/7_a.txt
102 should
103 .Pq depending on where your installation has put various files
104 display the quiver given by Fock and Goncharov when considering the
105 representation of a hyperbolic 3-simplex into SL(7, C). Performing the
106 following sequence of mutations:
108 .D1 m 10 4 0 2 a 1a
109 .D1 m 11 5 1 9 19 23 f 3 b 1b
110 .D1 m 12 6 8 18 4 0 2 a 22 e c 1c
111 .D1 m 13 7 17 5 1 9 f 3 b 21 d 1d
112 .D1 m 14 16 6 8 0 2 e c 20 1e
113 .D1 m 15 7 1 3 d 1f
115 will transform the quiver into the one given by running
117 .D1 % cluster-algebra-visualize /usr/share/cluster-algebra-visualize/7_b.txt
119 .Sh REFERENCES
122 .%A Robert Marsh
123 .%B Lecture Notes on Cluster Algebras
124 .%D 2013
125 .%C Zürich
129 .%A Vladimir Fock
130 .%A Alexander Goncharov
131 .%D 2006
132 .%T Moduli Spaces of Local Systems and Higher Teichmüller Theory
133 .%J Publications Mathématiques de l’Institut des Hautes Études Scientifiques 103
134 .%V 1
135 .%P 1–211
136 .%O DOI 10.1007/s10240-006-0039-4. Preprint at http://arxiv.org/abs/math/0311149v4
138 .Sh BUGS
139 .Bl -item
141 No good error handling
143 The display is a haphazard mixture of Unicode and ASCII. The author
144 would have preferred to use Unicode's drawing characters completely,
145 but found too many spacing errors in popular fonts to proceed.
147 Arrows with multiplicities greater than 1 are simply drawn in reverse
148 color.  It is not easy to see what their multiplicity actually is,
149 other than saving the quiver state and counting the number of times
150 the arrow appears in the output.
152 Arrows which overlap other arrows are not necessarily drawn
153 intelligently. If vertices are placed close together, the quiver may
154 be hard to read.
156 To delete an arrow, add an arrow going the other way.