h7SrSSKrSSKJr SSKrSSKrSSKJ r SSK J r SSK J r SSKJr \R"\5rSrS /rS rS rSrS rS r"SS5rg)z7 Module for creating Sankey diagrams using Matplotlib. N)SimpleNamespace)Path) PathPatch)Affine2D) _docstringzKevin L. Daviesz Yannick CopinBSDz 2011/09/16c\rSrSrSrS SjrS SjrSrSr\ R4Sjr \ RSS j5rS rS rg)SankeyaF Sankey diagram. Sankey diagrams are a specific type of flow diagram, in which the width of the arrows is shown proportionally to the flow quantity. They are typically used to visualize energy or material or cost transfers between processes. `Wikipedia (6/1/2011) `_ Nc  US:a [S5eXe:a [S5eU S:a [S5eU S:a [S5eUc)SSKJn U R5nUR SSS//S9n/UlXlX0lX@lX l XPl X`l Xpl Xl Xl[R "[R"SU S - - -S - 5UlXl[R("[R*[R**[R*[R**45Ul[/U 5(aUR0"S 0U D6 gg) a Create a new Sankey instance. The optional arguments listed below are applied to all subdiagrams so that there is consistent alignment and formatting. In order to draw a complex Sankey diagram, create an instance of `Sankey` by calling it without any kwargs:: sankey = Sankey() Then add simple Sankey sub-diagrams:: sankey.add() # 1 sankey.add() # 2 #... sankey.add() # n Finally, create the full diagram:: sankey.finish() Or, instead, simply daisy-chain those calls:: Sankey().add().add... .add().finish() Other Parameters ---------------- ax : `~matplotlib.axes.Axes` Axes onto which the data should be plotted. If *ax* isn't provided, new Axes will be created. scale : float Scaling factor for the flows. *scale* sizes the width of the paths in order to maintain proper layout. The same scale is applied to all subdiagrams. The value should be chosen such that the product of the scale and the sum of the inputs is approximately 1.0 (and the product of the scale and the sum of the outputs is approximately -1.0). unit : str The physical unit associated with the flow quantities. If *unit* is None, then none of the quantities are labeled. format : str or callable A Python number formatting string or callable used to label the flows with their quantities (i.e., a number times a unit, where the unit is given). If a format string is given, the label will be ``format % quantity``. If a callable is given, it will be called with ``quantity`` as an argument. gap : float Space between paths that break in/break away to/from the top or bottom. radius : float Inner radius of the vertical paths. shoulder : float Size of the shoulders of output arrows. offset : float Text offset (from the dip or tip of the arrow). head_angle : float Angle, in degrees, of the arrow heads (and negative of the angle of the tails). margin : float Minimum space between Sankey outlines and the edge of the plot area. tolerance : float Acceptable maximum of the magnitude of the sum of flows. The magnitude of the sum of connected flows cannot be greater than *tolerance*. **kwargs Any additional keyword arguments will be passed to `add`, which will create the first subdiagram. See Also -------- Sankey.add Sankey.finish Examples -------- .. plot:: gallery/specialty_plots/sankey_basics.py rzS'gap' is negative, which is not allowed because it would cause the paths to overlapz`'radius' is greater than 'gap', which is not allowed because it would cause the paths to overlapzp'head_angle' is negative, which is not allowed because it would cause inputs to look like outputs and vice versaz3'tolerance' is negative, but it must be a magnitudeNr )xticksyticksgf@@) ValueErrormatplotlib.pyplotpyplotfigure add_subplotdiagramsaxunitformatscalegapradiusshoulderoffsetmarginnptanpipitch tolerancearrayinfextentlenadd)selfrrrrrrrr head_angler!r&kwargspltfigs C/var/www/html/env/lib/python3.13/site-packages/matplotlib/sankey.py__init__Sankey.__init__*sNf 7-. . <67 7 >IJ J q=EG G : +**,CAqB?B        VVBEEQe);%;ef?)rNr r) rLINETOCURVE4r"r' column_stacklistziptileshape)r,quadrantcwrcenter ARC_CODES ARC_VERTICESverticess r1_arc Sankey._arcsc([[[[[[[[[[[[[[ " xx..!A"0.!A"0.!A"0.!A"0.!A"0.!A#1.!A!CD  v ''4R40??\!Q$-?,?-9!Q$-?,AB??\!Q$-?,?-9!Q$-?,AB a<WFC H#4););A)>(BC$DEF Fr4c UcSS/SS/4$USSupVUS- UR-nU[:XaXT-nXW-XcS- -/nUR[RXV/4[RU4[RXVU-/4[RXPR -Xc-/4/5 USUR - US/n X4$XPR -nU[:XaSn OSn XSS- - XjXG- -- /nU[:XaSn OSn UR(aPURURU U[:HURXPR-XjUR-- 4S95 O"UR[RXV/45 UR[RXVX-- /4[RU4[RXS- XjU-- /4/5 URURU U[:HX0R-XPR-XjUR-- 4S95 UR[RXS- XjU--/45 USUSXR -- /n X4$)z@ Add an input to a path and return its tip and label locations. rr8r r7rr@rArrB) r%RIGHTextendrr9rr UPDOWNrrFappend) r,pathangleflowlengthxydipdepthdiplabel_locationsignr@s r1 _add_inputSankey._add_inputs =q6Aq6> !8A;DAqDJJ.H~ |Q^4 dkkA62"kk3/"kkA4x=9"kkAL!(+CDFG#&a&4;;"6A!?D& &AXX B;DD!8|Q1B)C%CDD= H H;;KK 8-2b[1523kk/23T[[6H2H2J!*!KL KKqf 56 dkkA4=/@+AB"kk3/"kkAHa-6G+HIKL DIIx).$-1KK-?./++o./2D.D.F&GH  T[[18Q_*EFG"%a&#a&4++3E*E!F& &r4c UcSS/SS/4$USSupVURUS- - UR-nU[:XaXT- nXW-XcS- -/nUR[R XV/4[R XVUR-/4[R U4[R XVUR- U-/4[R XVU-/4[R XPR - Xc-/4/5 USUR-US/n X4$XPR - nU[:XaSupOSupXSS- - XjXG---/nUR(aPURURU U[:HURXPR- XjUR--4S95 O"UR[R XV/45 UR[R XVX--/4[R XPR- XjU--/4[R U4[R XPR-U- XjU--/4[R XS- XjU--/4/5 URURU U[:HURU- XPR- XjUR--4S95 UR[R XS- XjU--/45 USUSXR--/n X4$) zq Append an output to a path and return its tip and label locations. .. note:: *flow* is negative for an output. rr8r r7r)r r )r8rrI) rr%rJrKrr9rr rLrrFrNrM) r,rOrPrQrRrSrT tipheighttiprWrXr@s r1 _add_outputSankey._add_outputs =q6Aq6> !8A;DA1TZZ?I~ }a*n5 dkkA62"kkA4==/@+AB"kk3/"kkA4==/@4/G+HI"kkA4x=9"kkAL!(+CD FG #&a&4;;"6A!?@& &=XX B;%)ND(%*ND#:~q63E+F'FG;;KK 8-2b[1523kk/23T[[6H2H2J!*!KL KKqf 56 dkkA4=/@+AB"kkA ,=,-v ,=,?@"kk3/"kkA ,=,D,-v ,=,?@"kkAHa-6G+HI KL DIIx).$-1[[4-?./++o./2D.D.F&GH  T[[18Q_*EFG"%a&#a&4++3E*E!F& &r4cX/nUnUSSS2HupVURXF45 UnM U$)zw A path is not simply reversible by path[::-1] since the code specifies an action to take from the **previous** point. Nr8)rN)r,rO first_action reverse_path next_codecodepositions r1_revertSankey._revertLs@   "4R4jND    5 6I)r4c  #Uc[R"SS/5O[R"U5nURSn U cSn OU S-n UcSn[R"X;5n[R"XK5nUS:a [ S 5e[ [R "U55UR:a+[RS [R "U5U5 URU-n [ S U 55n [ S U 55nUGbUS:a [ S5e[U5S:a [ S5eU[UR5:a%[ SUS[UR5S35eUS[URUR5:a>[ SRUS[URUR555eUSU :a[ SUSSU S35eURUR USc[ SUSSUS35eURURUSX(S-n[ U5UR:a[ SUSURS35eS/U -n[#U5HWunnUUR:aSUU'MUUR*::aSUU'M5[RS UUUR5 MY S/U -n[#[%UU55HununnUS:Xa$U(a [&UU'M!USLa [(UU'M1M3US:XaUb [*UU'MGMIUS!:wa[ S"US#US$35eU(a [(UU'MsUSLdMz[&UU'M [R,"U5(a,[U5U :wa[ S%U S&[U5S'35eGOUnUnUnUn[/US(9nUVs/sHnUR1US5PM nn[#[%UUU 55HDununnnU[&:XaU(a UUU'UU- nM'U[(:XdM3USLdM:UUU'UU-nMF [#[3[5[%UUU 5555HNununnnU[(:XaU(aUXkU- S- 'UU- nM,U[&:XdM8USLdM?UXkU- S- 'UU-nMP Sn[#[3[5[%UU[%X55555H4ununnnU[*:XdMU(dMU(a SXkU- S- 'M2SnM6 Sn[#[%UU[5[%X5555H-ununnnU[*:XdMUSLdMU(aSUU'M+SnM/ [6R8UR:US)- - U S)- /4[6R<UR:US)- - S)- U S)- /4[6R>UR:US)- - S*- U S)- /4[6R>US)- UR:- S*- U*S)- /4[6R<US)- UR:- S)- U*S)- /4[6R<US)- UR:- U*S)- /4/n[6R<US)- UR:- US)- /4[6R<US)- UR:- S)- US)- /4[6R>US)- UR:- S*- US)- /4[6R>UR:US)- - S*- U *S)- /4[6R<UR:US)- - S)- U *S)- /4[6R<UR:US)- - U *S)- /4/n [6R<US)- UR:- US)- /4/n![6R<UR:US)- - U S)- /4/n"[R@"U S+45n#[R@"U S+45n$[#[%UU[5[%X5555HzununnnU[&:Xa.U(a'URB"U"U/UQ76uU#USS24'U$USS24'MBU[(:XdMNUSLdMUURD"UU/UQ76uU#USS24'U$USS24'M| [#[3[5[%UU[5[%X555555HununnnU[(:Xa>U(a7URB"U U/UQ76un%n&U%U#U U- S- SS24'U&U$U U- S- SS24'MRU[&:XdM^USLdMeURD"U!U/UQ76un%n&U%U#U U- S- SS24'U&U$U U- S- SS24'M Sn[#[3[5[%UU[5[%X555555HununnnU[*:XdMU(dMU(dOU S!SSU"S!SS:a5U RG[6R<U"S!SSU S!SS/45 SnURB"U U/UQ76un%n&U%U#U U- S- SS24'U&U$U U- S- SS24'M Sn[#[%UU[5[%X5555HununnnU[*:XdMUSLdMU(dOUS!SSU!S!SS:a5URG[6R<U!S!SSUS!SS/45 SnURD"UU/UQ76uU#USS24'U$USS24'M U(d U"RI5 U RI5 U(d U!RI5 URI5 UURKU!5-U -URKU"5-[6RLUSS4/-n'[%U'6un(n)[R"U)5n)S,n*Uc|U S:waWUVs/sH nU*"UU 5PM nn5RQU S--5RRn+U+"U#5n#U+"U$5n$U+"U)5n)URTRWSSUS.S.S/9n,GOURUR USUUS- n UVs/sH nU*"UU 5PM nn5RQU S--5RRn+U+"U#5n#URURXUSU#US- n-[O5RZ"U-6RRn.U."U#5n#U."U+"U$55n$U."U+"U)55n)[/US.S.S/9n/URTRV"U-0U/D6n,[\R^S0(aEU RIS1U RIS2S355n0U RIS4U RIS5S655n1ODU RIS1U RIS2S55n0U RIS4U RIS5S55n1U0c$URTR`Rc5n0[e[7U)U(54U0U1S7.U D6n2URTRgU25 /n3[%UUUU$5Hun4nn5n6U5bUcS8n5OURhb[kUR[l5(a&UR[ U45-URh-n7O7[oUR5(aURU45n7O [qS95eU5S8:waU5S:- n5U5U7- n5U3RGURTRWU6SU6SU5S.S.S;95 M [[R"U)SS2S45[R"U$SS2S45URrS5[u[Rt"U)SS2S45[Rt"U$SS2S45URrS5[[R"U)SS2S45[R"U$SS2S45URrS+5[u[Rt"U)SS2S45[Rt"U$SS2S45URrS<54Ul9URRG[wU2UUU#U,U3S=95 U$![a< [ S[R"U5S[R"U5S35Sef=f![a< [ S[R"U5S [R"U5S35Sef=fs snfs snfs snf)>u Add a simple Sankey diagram with flows at the same hierarchical level. Parameters ---------- patchlabel : str Label to be placed at the center of the diagram. Note that *label* (not *patchlabel*) can be passed as keyword argument to create an entry in the legend. flows : list of float Array of flow values. By convention, inputs are positive and outputs are negative. Flows are placed along the top of the diagram from the inside out in order of their index within *flows*. They are placed along the sides of the diagram from the top down and along the bottom from the outside in. If the sum of the inputs and outputs is nonzero, the discrepancy will appear as a cubic Bézier curve along the top and bottom edges of the trunk. orientations : list of {-1, 0, 1} List of orientations of the flows (or a single orientation to be used for all flows). Valid values are 0 (inputs from the left, outputs to the right), 1 (from and to the top) or -1 (from and to the bottom). labels : list of (str or None) List of labels for the flows (or a single label to be used for all flows). Each label may be *None* (no label), or a labeling string. If an entry is a (possibly empty) string, then the quantity for the corresponding flow will be shown below the string. However, if the *unit* of the main diagram is None, then quantities are never shown, regardless of the value of this argument. trunklength : float Length between the bases of the input and output groups (in data-space units). pathlengths : list of float List of lengths of the vertical arrows before break-in or after break-away. If a single value is given, then it will be applied to the first (inside) paths on the top and bottom, and the length of all other arrows will be justified accordingly. The *pathlengths* are not applied to the horizontal inputs and outputs. prior : int Index of the prior diagram to which this diagram should be connected. connect : (int, int) A (prior, this) tuple indexing the flow of the prior diagram and the flow of this diagram which should be connected. If this is the first diagram or *prior* is *None*, *connect* will be ignored. rotation : float Angle of rotation of the diagram in degrees. The interpretation of the *orientations* argument will be rotated accordingly (e.g., if *rotation* == 90, an *orientations* entry of 1 means to/from the left). *rotation* is ignored if this diagram is connected to an existing one (using *prior* and *connect*). Returns ------- Sankey The current `.Sankey` instance. Other Parameters ---------------- **kwargs Additional keyword arguments set `matplotlib.patches.PathPatch` properties, listed below. For example, one may want to use ``fill=False`` or ``label="A legend entry"``. %(Patch:kwdoc)s See Also -------- Sankey.finish Nr6grgV@zThe shapes of 'flows' z and 'orientations' z are incompatiblez and 'labels' zR'trunklength' is negative, which is not allowed because it would cause poor layoutzWThe sum of the flows is nonzero (%f; patchlabel=%r); is the system not at steady state?c3:# UHn[US5v M g7frN)max.0rQs r1 Sankey.add..9LD3tQ<._get_anglesyu r4ZrB)shavaz_internal.classic_modefc facecolorz#bfd1d4lw linewidthg?)r~rz*format must be callable or a format string )rSrTr{r|r}r )patchflowsanglestipstexttexts)wqzlK1126;<<}}U#**71:6> ))0 LH89::--.44WQZ@ +,J:$..0 ? |L::>..9ILMM VaZ  'GAtt~~% $ 1 $..( % 1  "#$dDNN< (!%.s</L%M !A!{ $F1I& "F1I'1' %F1I(R<$4QCuVHE5677 "F1I& $F1I%&N* ;;{ # #;1$ .qc2K());=>>% #H"H"H"H;'A8>?u155?K?/8FJx)56KA 2-1N/I % .7*d3|+I&J9L/M**E8TE>5(+-.KN/3,/M;;$(([3->">!%!-.;;$(([3->">#!E!%!-.;;$(([3->">#!E!%!-.;;+"3dhh">#!E"&!./;;+"3dhh">#!E"&!./;;+"3dhh">"&!./ 0;;+"3dhh">!%!-.;;+"3dhh">#!E!%!-.;;+"3dhh">#!E!%!-.;;$(([3->">#!E"&!./;;$(([3->">#!E"&!./;;$(([3->">"&!./ 0;;+"3dhh">!%!-./;;K#,=!=!%!-./xxA((Aq6**3Cj$s<'E"F5H+I &A&x}48OOE5*$(5*1QT OAqD1"U!2484D4DE5*$(5*1QT OAqD1 +I+4HT#j$s<'E"FCH>I5J+K &A&x{x&*oofe&Kd&K#^%(QUQY\"0>A 1 -$8u#4&*&6&6vu&Lt&L#^%(QUQY\"0>A 1 -+K*3HT#j$s<'E"FCH>I5J+K &A&x~((%bz!}Q'&*Q-*:: t{{VBZ]15E5;BZ]15E5G'HI%)N&*oofe&Kd&K#^%(QUQY\"0>A 1 -+K!*3Cj$s<'E"F5H+I &A&x~(e"3'bz!}Q'&*Q-*:: t{{VBZ]15E5;BZ]15E5G'HI'+$484D4DE5*$(5*1QT OAqD1+I JJL JJL JJL JJLf--6f9MM..&)A,/01t*x88H%  =1}CIJ6%*UH56J!..x"}=NNd|"("9!(+77<<1 xH<MD e,33GAJ?wqz*+H?EFvej1vFFZ**8b=9JJF$?BD&**[$"?@BD&**[$"?@B :..==?B$x/HB2HH % .1%2A/C *FE5(} &dkk3//#{{S[8499DHdkk**#{{62H#DFFB;TME! LL x{(-)1h&@ A/C.266(1a4.166/!Q$"78;;q>+266(1a4.166/!Q$"78;;q>+266(1a4.166/!Q$"78;;q>+266(1a4.166/!Q$"78;;q>+ ,  %uV$!%U 4 5  Q  (%(99M88L)**;=   (%(988F#$$57  |@nKGs5AC+)AD4AE=AF<AFC+AAD1D4AAE:c\URRURSUR- URSUR-URSUR- URSUR-/5 URR SSS9 UR $)a Adjust the Axes and return a list of information about the Sankey subdiagram(s). Returns a list of subdiagrams with the following fields: ======== ============================================================= Field Description ======== ============================================================= *patch* Sankey outline (a `~matplotlib.patches.PathPatch`). *flows* Flow values (positive for input, negative for output). *angles* List of angles of the arrows [deg/90]. For example, if the diagram has not been rotated, an input to the top side has an angle of 3 (DOWN), and an output from the top side has an angle of 1 (UP). If a flow has been skipped (because its magnitude is less than *tolerance*), then its angle will be *None*. *tips* (N, 2)-array of the (x, y) positions of the tips (or "dips") of the flow paths. If the magnitude of a flow is less the *tolerance* of this `Sankey` instance, the flow is skipped and its tip will be at the center of the diagram. *text* `.Text` instance for the diagram label. *texts* List of `.Text` instances for the flow labels. ======== ============================================================= See Also -------- Sankey.add rr r7r equaldatalim) adjustable)raxisr)r! set_aspectr)r,s r1finish Sankey.finish s>  dkk!nt{{2kk!nt{{2kk!nt{{2kk!nt{{24 5 7y9}}r4) rrr)rrr!r r%rrrr&r) Nr6rz%G?g?gQ?g333333?dg?gư>)rTr rr) rNNrr6rNrr)__name__ __module__ __qualname____firstlineno____doc__r2rFrYr^rr9rfrinterpdr+r__static_attributes__rr4r1r r sg FJDG'+}~7Fr2'h4'l*. $GICIiiV $r4r )rloggingtypesrnumpyr" matplotlibrmatplotlib.pathrmatplotlib.patchesrmatplotlib.transformsrr getLoggerrr __author__ __credits__ __license__ __version__rJrLrMr rr4r1rsh! (*!"      P P r4