From 73e8763db3f51f884e0b40c197d596a71ffef8d0 Mon Sep 17 00:00:00 2001 From: Brenda Praggastis Date: Tue, 8 Sep 2020 12:57:50 -0700 Subject: [PATCH 1/3] updating version number --- README.md | 3 --- docs/source/conf.py | 2 +- setup.py | 41 ++++++++++++++++++++--------------------- 3 files changed, 21 insertions(+), 25 deletions(-) diff --git a/README.md b/README.md index f99c9b2d..ac0c805b 100644 --- a/README.md +++ b/README.md @@ -33,7 +33,6 @@ Tutorials may be run in your browser using Google Colab - Open In Colab Tutorial 2 - Visualization Methods @@ -41,7 +40,6 @@ Tutorials may be run in your browser using Google Colab - Open In Colab Tutorial 3 - LesMis Case Study @@ -49,7 +47,6 @@ Tutorials may be run in your browser using Google Colab - Open In Colab Tutorial 4 - LesMis Visualizations-Book Tour diff --git a/docs/source/conf.py b/docs/source/conf.py index 3d3a9527..705f508d 100644 --- a/docs/source/conf.py +++ b/docs/source/conf.py @@ -19,7 +19,7 @@ import os import shlex -__version__ = "0.3.4" +__version__ = "0.3.5" # If extensions (or modules to document with autodoc) are in another directory, diff --git a/setup.py b/setup.py index 06a8c0ac..f5759121 100644 --- a/setup.py +++ b/setup.py @@ -1,15 +1,16 @@ -from setuptools import setup -import sys, os.path +from setuptools import setup +import sys +import os.path -__version__ = '0.3.4' +__version__ = '0.3.5' -if sys.version_info < (3,6): +if sys.version_info < (3, 6): sys.exit('HyperNetX requires Python 3.6 or later.') setup( name='hypernetx', packages=['hypernetx', - 'hypernetx.algorithms', + 'hypernetx.algorithms', 'hypernetx.classes', 'hypernetx.drawing', 'hypernetx.reports'], @@ -18,28 +19,26 @@ author_email="hypernetx@pnnl.gov", url='https://github.com/pnnl/HyperNetX', description='HyperNetX is a Python library for the creation and study of hypergraphs.', - install_requires=['networkx>=2.2,<3.0','numpy>=1.15.0,<2.0','scipy>=1.1.0,<2.0','matplotlib>3.0','scikit-learn>=0.20.0'], + install_requires=['networkx>=2.2,<3.0', 'numpy>=1.15.0,<2.0', 'scipy>=1.1.0,<2.0', 'matplotlib>3.0', 'scikit-learn>=0.20.0'], license='3-Clause BSD license', long_description=''' - The HyperNetX library provides classes and methods for complex network data. - HyperNetX uses data structures designed to represent set systems containing - nested data and/or multi-way relationships. The library generalizes traditional - graph metrics to hypergraphs. + The HyperNetX library provides classes and methods for complex network data. + HyperNetX uses data structures designed to represent set systems containing + nested data and/or multi-way relationships. The library generalizes traditional + graph metrics to hypergraphs. - The current version is preliminary. We are actively testing and would be grateful - for comments and suggestions. Expect changes in both class names and methods as + The current version is preliminary. We are actively testing and would be grateful + for comments and suggestions. Expect changes in both class names and methods as many of the requirements demanded of the library are worked out. ''', extras_require={ - 'testing':['pytest>=4.0'], - 'notebooks':['jupyter>=1.0','pandas>=0.23'], - 'tutorials':['jupyter>=1.0','pandas>=0.23'], - 'documentation':['sphinx>=1.8.2','nb2plots>=0.6','sphinx-rtd-theme>=0.4.2'], - 'all':['sphinx>=1.8.2','nb2plots>=0.6','sphinx-rtd-theme>=0.4.2','pytest>=4.0','jupyter>=1.0','pandas>=0.23'] + 'testing': ['pytest>=4.0'], + 'notebooks': ['jupyter>=1.0', 'pandas>=0.23'], + 'tutorials': ['jupyter>=1.0', 'pandas>=0.23'], + 'documentation': ['sphinx>=1.8.2', 'nb2plots>=0.6', 'sphinx-rtd-theme>=0.4.2'], + 'all': ['sphinx>=1.8.2', 'nb2plots>=0.6', 'sphinx-rtd-theme>=0.4.2', 'pytest>=4.0', 'jupyter>=1.0', 'pandas>=0.23'] } ) -### Since this package is still in development, please install in a virtualenv or conda environment. -### See README for installations instructions - - +# Since this package is still in development, please install in a virtualenv or conda environment. +# See README for installations instructions From 469ba0063cd866ac350414f2e678033d1e6b0669 Mon Sep 17 00:00:00 2001 From: Brenda Praggastis Date: Tue, 8 Sep 2020 13:02:33 -0700 Subject: [PATCH 2/3] updating docs --- docs/build/.buildinfo | 2 +- .../.doctrees/algorithms/algorithms.doctree | Bin 123590 -> 125156 bytes docs/build/.doctrees/environment.pickle | Bin 208261 -> 208485 bytes .../_modules/algorithms/homology_mod2.html | 2 +- .../algorithms/s_centrality_measures.html | 13 +++++++++++-- docs/build/_modules/classes/entity.html | 2 +- docs/build/_modules/classes/hypergraph.html | 2 +- docs/build/_modules/drawing/rubber_band.html | 2 +- docs/build/_modules/drawing/two_column.html | 2 +- docs/build/_modules/drawing/util.html | 2 +- docs/build/_modules/index.html | 2 +- .../_modules/reports/descriptive_stats.html | 2 +- docs/build/_static/documentation_options.js | 2 +- docs/build/algorithms/algorithms.html | 14 +++++++++++--- docs/build/algorithms/modules.html | 2 +- docs/build/classes/classes.html | 2 +- docs/build/classes/modules.html | 2 +- docs/build/drawing/drawing.html | 2 +- docs/build/drawing/modules.html | 2 +- docs/build/genindex.html | 2 +- docs/build/glossary.html | 2 +- docs/build/index.html | 2 +- docs/build/install.html | 2 +- docs/build/license.html | 2 +- docs/build/overview/index.html | 2 +- docs/build/py-modindex.html | 2 +- docs/build/reports/modules.html | 2 +- docs/build/reports/reports.html | 2 +- docs/build/search.html | 2 +- docs/build/searchindex.js | 2 +- hypernetx/algorithms/s_centrality_measures.py | 6 ++++++ 31 files changed, 54 insertions(+), 31 deletions(-) diff --git a/docs/build/.buildinfo b/docs/build/.buildinfo index b088336c..7f8381d9 100644 --- a/docs/build/.buildinfo +++ b/docs/build/.buildinfo @@ -1,4 +1,4 @@ # Sphinx build info version 1 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done. -config: 100d5f0571659fa080bb0f6ef7eebc72 +config: 12513d66143dfa27e7a4e78bbb5b3696 tags: 645f666f9bcd5a90fca523b33c5a78b7 diff --git a/docs/build/.doctrees/algorithms/algorithms.doctree b/docs/build/.doctrees/algorithms/algorithms.doctree index 174f4a4861bb9d7c33e16da040169144775abb7b..3d23841ad24a38f15f2882653da8b2e945751a7f 100644 GIT binary patch delta 2485 zcmbVOYiv_x80I;{_Oxv4${3ej&p@|zZG{cOCa&Bfmt-=z#ehiIn8o(Ebz9dG!KlC= zXI!Gv#y6m2M#4=^WHU?UI@uT(LES(n!+~6u=pO=T)E~yg@B2=>of6m&|D2w^@AE#- z^S_Z+jLDDLWNw=dxLR(k_mHoWAm4k&XJ z{$tjDlsdn%siv+fz_EUJAn5lsDglpMX><-(QhgWFrwEkS_p(x7=k)~?U$Azg+s~`$ z^DZn-;5W6W;iQ~ySSYUzYha}}+mML@$~lQ_+TVsn@;uv^F`jhQMJtXVb?59`*)m!CPG*{kO-%09F0h>f-c?$EkNkl`v1u10N2P0O~igpw| z#%-^Nwy_VBP{PC01ca8iqd1WR{@^t5B!m_?6sl*{)X|Q&q=PoPe+F5Rbzfqogif-a zfQ{~zA`QnPcRDa0_-;6sOj(CuOghFbGA2)k`mK$M4k3*yBUp$VnmeU97lU*qg1NXe z9FYcXw2e@Ne}+R0#BAo!;ZKqF0OyQktYfT2r;tjm$;iTZexI{*X&Jq@3$vtN8|9WE zgRKt_hxW{xBpqX+Wtd{=VCJekx$DE8Y3svk2fcd~OEP*{FzB(Veu$;|O4mT-{!vVp zm)AA zRa(sk?leC!N@`;G7kOl=Sms0*2Wb5C=I znf?LVLZ`0fk$FEdB%_`0ayBB7l(R6wG|?``Gr=Bu|9OWYnUP!VwE7&jC0cn#47_Nk2FW=^Lt|agU+oU7+-LLH8n4eCF1PUW z;E}CZgd?FAh^jTj)DB(6DrrZYS_2&)M5&bIpqihN#r+;`$3#Q<*b$nRD9!E|4L40I ze}TeJ+vJ$<-Fl|UMziKJN@pIP6NPU;2`PoL)Eynvi5oCIxrnzLYjC7*{sqyst9?4z zqZ0kyj2gQhGbZ}GEBdoUr^$2tfYA=@yZtcHg#nlz7%xBEV(JE+UfenI&`mKr>HZbu zv;PU$qD-Hw+ISzsk4?{O8kJYKNKZJm<(n!v^NG)=Oh2D-@dBgqR*XEx`5LY4a_V=l d!pV0pHZ7ie$h3;%mr>u9ei`-CqV2b^=s(2j5|sb| delta 1908 zcmaJ>YfKbZ6y9%m>@KjZU=ef|d1lKDSRO*!B4TV}NlQcIN1K8*shZVwN>Sudr75Ar zCM2Z+I@_GIrrANg-{R6??JF~dEQ2aA<=brET z&Ueo_b7w}4{e8wpH`WSY-aZq9$(p)Ep-d1OMCu5~ zR@AHG=MW9yJ&}@RY_-&LLAZikHn~Nl?9UNH#pm&i;1QLoXE);nT{@3K;VbP+I3ZFa zAzL`N6pT`lK&QVz%rc#i%M5frZCFv9WAG}50NXhvaAKL2|w|@1jUoP4)s)e z0UOrTFdutdNxR*yl-+K*MpUM9W2yWjWZGLm3$c&WhIL=-SR;>k*@-L#vY}FwaNrS{KL5vziFGKBKxtiJsV5hW8xMoV!85^l% z5Xp4!B0?g(x@JbQ@$D4aIRsIS|gi-vBaFsWGMsQSL^CDq^_jmf)&H+eXkRT$R+` z5j-D+R5fB0o*?5QgUa&~bzeuHafE*iO4KlhSO*_4HdpNNFWRjrJxp0`dZwakFRC{Ef)2-c1Ex{EBE1mA* zP=5J!=v@u?tC^6UMFV;$oYHMj)ie@$`=Sf)tg38&q_WAU%-bzo(Us9p_iiJ*AebFw o$zph*^GC`0O~j11Yod5s; diff --git a/docs/build/.doctrees/environment.pickle b/docs/build/.doctrees/environment.pickle index cc52055ea0b2a88d286ee1b56226247f27ee59c8..c7fca4ddb50c611f85084cd4bf169204f124a021 100644 GIT binary patch delta 5515 zcmbVQdsLLywdZ^wZ$VyyAo3U-UNWGBhsGB^qcp9AG%58l8Q~M=bB1s3%%Fi56I)Xq z9dTffe29P`YJ7l_HCE*v+{E+~{PKePT7CS4h~&aIA;hQ_V;h5rPD_C+=fo!UH>55LhSKw)}3e3706 zZCQ(8M4J=j;)_4v&S=R<=MHUF8mvoS2rU^IzAkA5hsME+B|RC| zX63@zJipJ<(p>OO*36)f)fi_+b6E;3%`U~2JF_3arFk0YnzI$=qnwlTEv(7az|^ut zFzSB9uEN0FRCsZH4E#&C4l;Eb=-;G)1G$^vojeUp%d3M+$eql43(n2ez*%by=;yA3 zpd1az_UZ6nbIaHjo?*j05x&YzgOJ9V@Yi{f5S9NrKXNJ4*T;t+x3ruzI%=tmG&*KU zPZ}MuWG0P{SNaKQbhMI#G&)vEA&rhyI!+pGRPvBUCn;SbjZRUzMH-b#y5}42<5TDK zv&)q>ccVK)8umQS&tov%mgf0hK{_cB@cAoAp5DTra>J8X{Bu>gI$y6UFTD6Gf#N(* z7qzO)i6vGBhkq(#J>%d=NjWq$ror@OAF>;s-!1!$K}NldB~FBbmF4iXKF!m&5@&i^ zug>JVdJ8u^4KKB+ie~K|)xEJI*mJG)jvp-9R0yLh7C=~;3>tl!r>6`PX!H@D&tGw= zO2eyNs*?Gdm$~u!&s1h(h0O3onY|WIv<8xjBVbxX6b!8&U{^hFZWv+5$P%2Y~l)BuN-EVJgrr0eL4TA8VfP} zV;QeTD*V$}4!!HsJSJ%)LnXpEuoka)Ip{ zoLV8{wKBq)Qgszi>`4rbNXXfCgI)GK-j*joT!{=D=EXo?eK|ZTNdry80DQVE((`4* z`wXVOVZj?H!~JSCL02PI?|yY8+y_>II!x{gTFT`U#&MMP@|zWw=fb^}Uw&4{3T zz0obX0(^W7d@Sq`=LGQqNMC{OUD+5pyer`?igZce59B{~9_o_TO|r@-S+7m9DkfPQ zCRzGPmSK{$I#`|Wif79^r`Z}R#~xk{2QS7RUJC~=g@aeZ!3*Kw3v}=@ICvEtd`}Ku z0|%C%Vs}1%g!b<)M!dGW2=Tk!1&A-~nTL4GksVPZn`M(+U5{Tzo6+W$hM{-QD)fcz z%MLZx+C{6yD%y!oaZr*JM>bq=1o~IWoV?{I^fy#hk^h#1zSJRm=OeD%yB5*4cR6RW z;pyHm)WY@^l5gJ&hzf%%+#&j#wBcLo zOeU*XZM50(NkwjFQz6ASrNd~`RIa_?9ci@bMYF}uqi7nFxJ@+iAqVm>L|t1L+&MtQ zb~b4t)HMyYMAst3^{#ou9?*tNoa~}Y=Z!6G4)dj4qaAUus5uSUv3z@)DPL>z9Kqrabz`$(9r!_aO8{~wTUJq2%ZrFRo5&M^+Ge1vyCFM-zWvTAYJYG} z(ZGG6$~|q@p%$oEnuS0#``o$82Z}%=QH6H5sx3wPEBAbF{0|S(4soPX0RpMV559!> zkAuq*6OQQMjn+`q%&jjYe$cuCac5H;R9uOH93=>?zAl}zuvMV>ElR#hgjC^S7-}o| z5#Cd%{E=-d5ffc;U}>9;8m)C{+Y}|dT?iR>BnCYjw)ijw`1$c;ruEIa$)r5+pX`Bse;p}LK4&HAML;qJ8dfLS&d)mGjiN%Kt5bcMTApVjgP8ld$ zt3)duYkztuo)XTgEgLQmn|mo zO`eku-`_0SYvd~TFR-)p_KP&zpO2)lk(O>P8-euh#fTSsw2<8G2d?fgw2pMopTq?O z*2-0sa|Cu_U~x}0x?k=oMBLT0fQJ?%KJKA}Nk?ZRt~^@A`FQx`Xb4F7um5P^I5P{i z2S<|;r}gR(m-OZ$%DrPl%5XHY-@I zF$SJv4swQmPGd3OKF73$Ql5!1?VO?KY;4q^%Dgmz`t@@`pFGEW${Fgi#u7bN8R&nv zf?bDzlR1b5Ckqix9D7gBNBthh*i-qam!6`S`cv76$4})V-sUvFOi&_X2)YPJ&76Jve z5GbgZMKJ^^?^VPpE|!gW%(v2~1dgTjbo{>DFYW)5(i8Q$#t)mR zqI<#WL+_aI&^!L$5B=Uh>v#zo)e@kf5}=?Gpr8_pc0^<5}=?G zpcwK@9eq;Dz8DP7W^W6t=y%}^#us02m-SY8J3jox1a98?vcYaOzUj56RLVBqHIOsx zxfVnDB!?yQU!5~(Vvj-5AzLeJ4942AZiG|VpBO6*CcWBp@SJ0m*W$> zma-YXa%q=xcPUGq$yXMJUCCHNBQ+AApW_>n^?`;g6y;US^kkg-lmd2oRxK7Iw@#lbP2OoaK8b8C>T1ALg7c~RI+}O7&rxhU;#fT~%qEKspzeR{c zeqEa|12!GRHi6V+6#vmCWT`1;K}2h^s>Yxi%^Lw_v`xsxu<%2IHlFV%;-z{EmeOjl z)aa_jYOBcW^@Bq~d@T2eP4pYhRLr;0nZTXl6Plt zmk_OLmr&zvRG_*RXRPvGvoJk?+9O&T`r~ovXNQGZ>HyizSFor?~(9L zP^`L;YSB&!MLoYO7^j?nLaQIV{X{sHTSR?@GpJHFTlCbB;}bwch%{xx!p$xO8UFV2X*2i4Kl1 zum`U}KoCt;Ad+=cSc!S$(XgYO=akn%3C8&m9QV{_(Bv4}N>^ z-`;1RbM`rN&*t+_LSMZdI(S`RMe2y)3}!{}Y}i~hn!5|~%v!d+RA8mg7?T1Oy#WCyW z^^2u<$E;fkX6f>n^>I+2G(2YgZHp|u_nme7L+Sl7>%RJ>bY;wXu==!g;XCV(uSp}t zW9F9|{G_X6)>qS~OV_`%)<2T2jalD>sbI`_f?a~ni~=xZ=7Erz!e+y!%y{^7MjWJN z&JS|)#W#DhpgB8BaHT>^cC5cx<1jnw;oFRKrXvDQWrk6-uUi_1=FC{wnH31HWEVkO zmX584-)8BcEIS*lS=sPmP6YS-z8W#O4%%Z|3tbkTV0m z$w>$r(IQ=0EfuM-D7PFp;L5!RrG+}^nzr8?o(`Tb6xlT%5!{dnzb}l0sk48?PhZOR_3_~+FD)UBPF<=XjZR!LkVdC1SxKXl zmR=-{PFZr2Mkg#Oq|xb0$4H~iN-Ak|sL}<}=s=|#q*2kNJHC^BeCk|&4!P3qY4Bu8 zm(;Ik7cl5upRRsyP9`Z4aO;_5wYT^u+)xWjUeT0Gr3OtYdg6>gaq6Qd4`|FA3vCRt z>Se5HEF3Od3y%aIuF7tWY8JX)t(AWpfg0Mx1Mop z%8nm&X-f99Ugp}5eyTAW*2xS^W*LvR8ak|e32ngHP>E1iZ?Fc2AF>TfD&|xdVKBjC?HY z6lVtU0Z3nm?%lZ0qOoY4pGEnn({Qz;jD~Wur1okc{E*;`Kt{lW#B^JJQ#iRCxCl;>n4~Iqj zr=qp1IRkd=4<>$pMqs5yt`R-bXizGr^R%!K(IQ&$LBJiNzbRw#mO6{YCRUm44qH8O zyPAqAz9|##HidDm$UD+(H;C3+2alp@EaEoN!iO{$V2HN1aQIC#4cpa}0io_Gs3p3e zL|pGKB(^ytWc+03+(C*Q+MQDHFDfPzxu#I+zBb8E*KH zgra6W@D$=Z2bLo4YKnz*7o#Ch2|}yCORpp-0?l8m%+`ny6CQ@Krjj4w9fistd2ktG zqB|C956(c1*1G86B;{Va5HjXS4Ek=^f5^Z#h_gZ7& zosLAs-68mS&vgzNbUd1mF7@4x`H0<}1u(gDlJeIMfr{1LIWJH&RbeBDdAd8xkosLG zZJ$;%r7J|+lh{RP+}~A#NHg23jkUaB@rUOjbw|+$*v&gQgEgMvkZUdC3p^(szQ0v; zRLdsMYaUmCw+*G)K0TbuhFiNc*f3;vFF-uklL0B+e&Fs7N9%BR=>#qyutqjf&SBV% zfh9dr=zglF7;$&cJRVwt_;n8@Og=ILaoLf%oR5Q>M?yftzkwrxV@wii_l~3>PU+Pn zF6_-mlzV3(_VmUhp6$)V_u}*362zpVa}l3CT8ijCO3d)l`H23BMi^-Vh%jY)!CQqYOO8v~h-h zPNOjoA7c)NQl9ZK?VO?KY;@F+#;hDiz4utq&BvGzI729 z94|(+aO^!^iuxUnF(+oDUVegN>QCe%9y^hb_z~CHNj>TXC+8tWwK>X#vEX4Z*^V$1q-kTd38v9Po#+KyVDHC4l^g;TNFCWZ8lm}BIc^~?-Fdv`S zJkm)N*qt94%;7BrzUA~E4GO9|3hHQ4P|ZX7%jQsTek_T5n`d3LH(TcKm9sU;6(gr8@PN&W~MH=iUj{9(w1v zhu-=Be&`!N)$8SHTZGkToC7QqeLh-^=!HDbcE9Lm9T2a zn9rJgmHUP4w31lL77Tqpn@#p3+cLDdgo(n?)p_hMf^SMn%8+{j`%GZD%8$!fj<3GF zO6e+N(|x7#HswqiOH1H0g=3ddiT|@>6)W+-R`2}DQ0hvZL;-cm13l9Xl`Up@4O8iC zUBS!v|F?R+|96#L=h$>VawxOTvV>?J66y^Z?TnNg=U8&V1eZy~4qv-1uBqPe|LBdB zr1LCp+JsS~J&*v+A4Ml|SG0GqRkT%!29efg<`0ju>patG!^6BWHqk0?qen_PbDkym z^YQV@x$`VqIdzr=YD6ULYKf}gz7X#?@6$%R57MZ$bj^5-H#ZXAicr+#u_*mm4NMo< zO!ltQa)G5zSUHWfiP#UCD;;>fG40UJ3#{RPG4}fhg*a_d(;?i0eW=oSP)I{DpoyC( zwA!BsAr|?9*M;e@u??SnQd3Y=ye{NuDUu-KK#HbDqZ-8@cIDjbLOzDwdtJzg9uw^(L{(Ch~gaw+nGG+#f#PZ?;k~H=#40J138K))}c?rJEswfX$$Crd>!z z@o_s}*+0?pZcbq%crhu}{6pNg;Sk^E%P6#v80c&FUbBW4zSU2)$kYxYP6=zFPDepK zRVznIix8!0J*e@vC{SCAD@JK)6{ZDHyF*Jue;f`y-614t1D1ubl# zl(J4CQ;YhfO^DaD7uy7E5tX+(d7cp*7W-H!y!Yoomk>9JoOMtO(L+UDf_1(heIb>* zw{Y~Za{glhKk-W0SGdDrX7Rz z;hUfsZ6Q^ngA$4cepN6|>3m45ANu)2;b{I`Y7<;Rm9n+gK>am-(TNDrZq#@xnA`?z zrRjg9Yl=J1H`<@aPE*{ezSBy)BmHpW_}kFZl8!kl$I{wyxf5rKf(N&wsOwUu=zZg( QwAr<`baZxQq24#+-!Y>Q_y7O^ diff --git a/docs/build/_modules/algorithms/homology_mod2.html b/docs/build/_modules/algorithms/homology_mod2.html index e04f7a90..524dae71 100644 --- a/docs/build/_modules/algorithms/homology_mod2.html +++ b/docs/build/_modules/algorithms/homology_mod2.html @@ -8,7 +8,7 @@ - algorithms.homology_mod2 — HyperNetX 0.3.4 documentation + algorithms.homology_mod2 — HyperNetX 0.3.5 documentation diff --git a/docs/build/_modules/algorithms/s_centrality_measures.html b/docs/build/_modules/algorithms/s_centrality_measures.html index fde9ab8c..27c3ef2f 100644 --- a/docs/build/_modules/algorithms/s_centrality_measures.html +++ b/docs/build/_modules/algorithms/s_centrality_measures.html @@ -8,7 +8,7 @@ - algorithms.s_centrality_measures — HyperNetX 0.3.4 documentation + algorithms.s_centrality_measures — HyperNetX 0.3.5 documentation @@ -193,10 +193,12 @@

Source code for algorithms.s_centrality_measures

A dictionary of s-betweenness centrality value of the edges. ''' + # Confirm there is at least 1 s edge for which we can compute the centrality # Find all s-edges #M,rdict,_ = H.incidence_matrix(index=True) #A = M.transpose().dot(M) + A, coldict = H.edge_adjacency_matrix(s=s, index=True) A.setdiag(0) A = (A >= s) * 1 @@ -227,8 +229,10 @@

Source code for algorithms.s_centrality_measures

If edge then a single value is returned. ''' + # Confirm there is at least 1 s edge for which we can compute the centrality # Find all s-edges + if edge and len(H.edges[edge]) < s: return 0 @@ -250,6 +254,7 @@

Source code for algorithms.s_centrality_measures

# confirm there are at least 2 s-edges # we follow the NX convention that the s-closeness centrality of a single edge Hypergraph is 0 + output = {} if not bool(Es) or len(Es) == 1: output = {e: 0 for e in edges} @@ -280,7 +285,11 @@

Source code for algorithms.s_centrality_measures

eccentricity[f] : float else: eccentricity_dict : dict - + : dict or float + returns the s-eccentricity value of the edges, a floating point number + If edge=None a dictionary of values for each s-edge in H is returned. + If edge then a single value is returned. + ''' if f: if isinstance(f, Entity): diff --git a/docs/build/_modules/classes/entity.html b/docs/build/_modules/classes/entity.html index b8bb3fd5..79c7c5ba 100644 --- a/docs/build/_modules/classes/entity.html +++ b/docs/build/_modules/classes/entity.html @@ -8,7 +8,7 @@ - classes.entity — HyperNetX 0.3.4 documentation + classes.entity — HyperNetX 0.3.5 documentation diff --git a/docs/build/_modules/classes/hypergraph.html b/docs/build/_modules/classes/hypergraph.html index 98df0572..d35cec2e 100644 --- a/docs/build/_modules/classes/hypergraph.html +++ b/docs/build/_modules/classes/hypergraph.html @@ -8,7 +8,7 @@ - classes.hypergraph — HyperNetX 0.3.4 documentation + classes.hypergraph — HyperNetX 0.3.5 documentation diff --git a/docs/build/_modules/drawing/rubber_band.html b/docs/build/_modules/drawing/rubber_band.html index ea2b8369..11b98e95 100644 --- a/docs/build/_modules/drawing/rubber_band.html +++ b/docs/build/_modules/drawing/rubber_band.html @@ -8,7 +8,7 @@ - drawing.rubber_band — HyperNetX 0.3.4 documentation + drawing.rubber_band — HyperNetX 0.3.5 documentation diff --git a/docs/build/_modules/drawing/two_column.html b/docs/build/_modules/drawing/two_column.html index 7c977043..352a2116 100644 --- a/docs/build/_modules/drawing/two_column.html +++ b/docs/build/_modules/drawing/two_column.html @@ -8,7 +8,7 @@ - drawing.two_column — HyperNetX 0.3.4 documentation + drawing.two_column — HyperNetX 0.3.5 documentation diff --git a/docs/build/_modules/drawing/util.html b/docs/build/_modules/drawing/util.html index 0e71704e..50b7a36f 100644 --- a/docs/build/_modules/drawing/util.html +++ b/docs/build/_modules/drawing/util.html @@ -8,7 +8,7 @@ - drawing.util — HyperNetX 0.3.4 documentation + drawing.util — HyperNetX 0.3.5 documentation diff --git a/docs/build/_modules/index.html b/docs/build/_modules/index.html index ff8e508d..9a56bc17 100644 --- a/docs/build/_modules/index.html +++ b/docs/build/_modules/index.html @@ -8,7 +8,7 @@ - Overview: module code — HyperNetX 0.3.4 documentation + Overview: module code — HyperNetX 0.3.5 documentation diff --git a/docs/build/_modules/reports/descriptive_stats.html b/docs/build/_modules/reports/descriptive_stats.html index bf2ab790..099b33f3 100644 --- a/docs/build/_modules/reports/descriptive_stats.html +++ b/docs/build/_modules/reports/descriptive_stats.html @@ -8,7 +8,7 @@ - reports.descriptive_stats — HyperNetX 0.3.4 documentation + reports.descriptive_stats — HyperNetX 0.3.5 documentation diff --git a/docs/build/_static/documentation_options.js b/docs/build/_static/documentation_options.js index 6e4da6fd..883b606f 100644 --- a/docs/build/_static/documentation_options.js +++ b/docs/build/_static/documentation_options.js @@ -1,6 +1,6 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '0.3.4', + VERSION: '0.3.5', LANGUAGE: 'None', COLLAPSE_INDEX: false, BUILDER: 'html', diff --git a/docs/build/algorithms/algorithms.html b/docs/build/algorithms/algorithms.html index 96106adb..51d97608 100644 --- a/docs/build/algorithms/algorithms.html +++ b/docs/build/algorithms/algorithms.html @@ -8,7 +8,7 @@ - algorithms package — HyperNetX 0.3.4 documentation + algorithms package — HyperNetX 0.3.5 documentation @@ -630,10 +630,18 @@

Homology Mod2 +
if f:

eccentricity[f] : float

-
else:

eccentricity_dict : dict

+
else:
+

eccentricity_dict : dict

+
+
+
: dict or float

returns the s-eccentricity value of the edges, a floating point number +If edge=None a dictionary of values for each s-edge in H is returned. +If edge then a single value is returned.

+
+
diff --git a/docs/build/algorithms/modules.html b/docs/build/algorithms/modules.html index 3c3fbb74..52eb3a45 100644 --- a/docs/build/algorithms/modules.html +++ b/docs/build/algorithms/modules.html @@ -8,7 +8,7 @@ - algorithms — HyperNetX 0.3.4 documentation + algorithms — HyperNetX 0.3.5 documentation diff --git a/docs/build/classes/classes.html b/docs/build/classes/classes.html index 6519bcfd..0d765a01 100644 --- a/docs/build/classes/classes.html +++ b/docs/build/classes/classes.html @@ -8,7 +8,7 @@ - classes package — HyperNetX 0.3.4 documentation + classes package — HyperNetX 0.3.5 documentation diff --git a/docs/build/classes/modules.html b/docs/build/classes/modules.html index 9913da1a..bdd51296 100644 --- a/docs/build/classes/modules.html +++ b/docs/build/classes/modules.html @@ -8,7 +8,7 @@ - classes — HyperNetX 0.3.4 documentation + classes — HyperNetX 0.3.5 documentation diff --git a/docs/build/drawing/drawing.html b/docs/build/drawing/drawing.html index f0a41b20..2923aa73 100644 --- a/docs/build/drawing/drawing.html +++ b/docs/build/drawing/drawing.html @@ -8,7 +8,7 @@ - drawing package — HyperNetX 0.3.4 documentation + drawing package — HyperNetX 0.3.5 documentation diff --git a/docs/build/drawing/modules.html b/docs/build/drawing/modules.html index 82eedc21..9b1ca2e8 100644 --- a/docs/build/drawing/modules.html +++ b/docs/build/drawing/modules.html @@ -8,7 +8,7 @@ - drawing — HyperNetX 0.3.4 documentation + drawing — HyperNetX 0.3.5 documentation diff --git a/docs/build/genindex.html b/docs/build/genindex.html index f6432d5e..d72a5c80 100644 --- a/docs/build/genindex.html +++ b/docs/build/genindex.html @@ -9,7 +9,7 @@ - Index — HyperNetX 0.3.4 documentation + Index — HyperNetX 0.3.5 documentation diff --git a/docs/build/glossary.html b/docs/build/glossary.html index 8a412121..48f4fc33 100644 --- a/docs/build/glossary.html +++ b/docs/build/glossary.html @@ -8,7 +8,7 @@ - Glossary of HNX terms — HyperNetX 0.3.4 documentation + Glossary of HNX terms — HyperNetX 0.3.5 documentation diff --git a/docs/build/index.html b/docs/build/index.html index 0cbbfe5a..255ddf92 100644 --- a/docs/build/index.html +++ b/docs/build/index.html @@ -8,7 +8,7 @@ - HyperNetX (HNX) — HyperNetX 0.3.4 documentation + HyperNetX (HNX) — HyperNetX 0.3.5 documentation diff --git a/docs/build/install.html b/docs/build/install.html index 890dd8a3..9e26fadc 100644 --- a/docs/build/install.html +++ b/docs/build/install.html @@ -8,7 +8,7 @@ - Installing HyperNetX — HyperNetX 0.3.4 documentation + Installing HyperNetX — HyperNetX 0.3.5 documentation diff --git a/docs/build/license.html b/docs/build/license.html index ab054128..20805e71 100644 --- a/docs/build/license.html +++ b/docs/build/license.html @@ -8,7 +8,7 @@ - License — HyperNetX 0.3.4 documentation + License — HyperNetX 0.3.5 documentation diff --git a/docs/build/overview/index.html b/docs/build/overview/index.html index 1dda0f8e..e1dcae6f 100644 --- a/docs/build/overview/index.html +++ b/docs/build/overview/index.html @@ -8,7 +8,7 @@ - Overview — HyperNetX 0.3.4 documentation + Overview — HyperNetX 0.3.5 documentation diff --git a/docs/build/py-modindex.html b/docs/build/py-modindex.html index ce4e9d6c..c6528fe6 100644 --- a/docs/build/py-modindex.html +++ b/docs/build/py-modindex.html @@ -8,7 +8,7 @@ - Python Module Index — HyperNetX 0.3.4 documentation + Python Module Index — HyperNetX 0.3.5 documentation diff --git a/docs/build/reports/modules.html b/docs/build/reports/modules.html index f13a1467..ec4413f1 100644 --- a/docs/build/reports/modules.html +++ b/docs/build/reports/modules.html @@ -8,7 +8,7 @@ - reports — HyperNetX 0.3.4 documentation + reports — HyperNetX 0.3.5 documentation diff --git a/docs/build/reports/reports.html b/docs/build/reports/reports.html index a9c0d014..6436b5e2 100644 --- a/docs/build/reports/reports.html +++ b/docs/build/reports/reports.html @@ -8,7 +8,7 @@ - reports package — HyperNetX 0.3.4 documentation + reports package — HyperNetX 0.3.5 documentation diff --git a/docs/build/search.html b/docs/build/search.html index 90bdd44d..b330fd4e 100644 --- a/docs/build/search.html +++ b/docs/build/search.html @@ -8,7 +8,7 @@ - Search — HyperNetX 0.3.4 documentation + Search — HyperNetX 0.3.5 documentation diff --git a/docs/build/searchindex.js b/docs/build/searchindex.js index b981cdc7..976b5739 100644 --- a/docs/build/searchindex.js +++ b/docs/build/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["algorithms/algorithms","algorithms/modules","classes/classes","classes/modules","drawing/drawing","drawing/modules","glossary","index","install","license","overview/index","reports/modules","reports/reports"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["algorithms/algorithms.rst","algorithms/modules.rst","classes/classes.rst","classes/modules.rst","drawing/drawing.rst","drawing/modules.rst","glossary.rst","index.rst","install.rst","license.rst","overview/index.rst","reports/modules.rst","reports/reports.rst"],objects:{"":{algorithms:[0,0,0,"-"],classes:[2,0,0,"-"],drawing:[4,0,0,"-"],reports:[12,0,0,"-"]},"algorithms.homology_mod2":{add_to_column:[0,1,1,""],add_to_row:[0,1,1,""],bkMatrix:[0,1,1,""],coset:[0,1,1,""],homology_basis:[0,1,1,""],hypergraph_homology_basis:[0,1,1,""],interpret:[0,1,1,""],kchainbasis:[0,1,1,""],logical_dot:[0,1,1,""],logical_matadd:[0,1,1,""],logical_matmul:[0,1,1,""],matmulreduce:[0,1,1,""],reduced_row_echelon_form_mod2:[0,1,1,""],smith_normal_form_mod2:[0,1,1,""],swap_columns:[0,1,1,""],swap_rows:[0,1,1,""]},"algorithms.s_centrality_measures":{s_betweenness_centrality:[0,1,1,""],s_eccentricity:[0,1,1,""],s_harmonic_closeness_centrality:[0,1,1,""]},"classes.entity":{Entity:[2,2,1,""],EntitySet:[2,2,1,""]},"classes.entity.Entity":{add:[2,3,1,""],add_element:[2,3,1,""],add_elements_from:[2,3,1,""],children:[2,3,1,""],clone:[2,3,1,""],complete_registry:[2,3,1,""],depth:[2,3,1,""],elements:[2,3,1,""],fullregistry:[2,3,1,""],incidence_dict:[2,3,1,""],intersection:[2,3,1,""],is_bipartite:[2,3,1,""],is_empty:[2,3,1,""],level:[2,3,1,""],levelset:[2,3,1,""],memberships:[2,3,1,""],merge_entities:[2,3,1,""],nested_incidence_dict:[2,3,1,""],properties:[2,3,1,""],registry:[2,3,1,""],remove:[2,3,1,""],remove_element:[2,3,1,""],remove_elements_from:[2,3,1,""],restrict_to:[2,3,1,""],size:[2,3,1,""],uid:[2,3,1,""],uidset:[2,3,1,""]},"classes.entity.EntitySet":{add:[2,3,1,""],clone:[2,3,1,""],collapse_identical_elements:[2,3,1,""],incidence_matrix:[2,3,1,""],restrict_to:[2,3,1,""]},"classes.hypergraph":{Hypergraph:[2,2,1,""]},"classes.hypergraph.Hypergraph":{add_edge:[2,3,1,""],add_edges_from:[2,3,1,""],add_node_to_edge:[2,3,1,""],adjacency_matrix:[2,3,1,""],auxiliary_matrix:[2,3,1,""],bipartite:[2,3,1,""],collapse_edges:[2,3,1,""],collapse_nodes:[2,3,1,""],collapse_nodes_and_edges:[2,3,1,""],component_subgraphs:[2,3,1,""],components:[2,3,1,""],connected_component_subgraphs:[2,3,1,""],connected_components:[2,3,1,""],degree:[2,3,1,""],diameter:[2,3,1,""],dim:[2,3,1,""],distance:[2,3,1,""],dual:[2,3,1,""],edge_adjacency_matrix:[2,3,1,""],edge_diameter:[2,3,1,""],edge_diameters:[2,3,1,""],edge_distance:[2,3,1,""],edges:[2,3,1,""],from_bipartite:[2,3,1,""],from_dataframe:[2,3,1,""],from_numpy_array:[2,3,1,""],incidence_dict:[2,3,1,""],incidence_matrix:[2,3,1,""],is_connected:[2,3,1,""],neighbors:[2,3,1,""],node_diameters:[2,3,1,""],nodes:[2,3,1,""],number_of_edges:[2,3,1,""],number_of_nodes:[2,3,1,""],order:[2,3,1,""],remove_edge:[2,3,1,""],remove_edges:[2,3,1,""],remove_node:[2,3,1,""],remove_nodes:[2,3,1,""],remove_singletons:[2,3,1,""],restrict_to_edges:[2,3,1,""],restrict_to_nodes:[2,3,1,""],s_component_subgraphs:[2,3,1,""],s_components:[2,3,1,""],s_connected_components:[2,3,1,""],s_degree:[2,3,1,""],shape:[2,3,1,""],singletons:[2,3,1,""],size:[2,3,1,""],toplexes:[2,3,1,""]},"drawing.rubber_band":{draw:[4,1,1,""],draw_hyper_edge_labels:[4,1,1,""],draw_hyper_edges:[4,1,1,""],draw_hyper_labels:[4,1,1,""],draw_hyper_nodes:[4,1,1,""],get_default_radius:[4,1,1,""],inflate_kwargs:[4,1,1,""],layout_hyper_edges:[4,1,1,""],layout_node_link:[4,1,1,""]},"drawing.two_column":{draw:[4,1,1,""],draw_hyper_edges:[4,1,1,""],draw_hyper_labels:[4,1,1,""],layout_two_column:[4,1,1,""]},"drawing.util":{get_frozenset_label:[4,1,1,""],get_line_graph:[4,1,1,""],get_set_layering:[4,1,1,""]},"reports.descriptive_stats":{centrality_stats:[12,1,1,""],comp_dist:[12,1,1,""],degree_dist:[12,1,1,""],dist_stats:[12,1,1,""],edge_size_dist:[12,1,1,""],frequency_distribution:[12,1,1,""],info:[12,1,1,""],info_dict:[12,1,1,""],s_comp_dist:[12,1,1,""],s_edge_diameter_dist:[12,1,1,""],s_node_diameter_dist:[12,1,1,""],toplex_dist:[12,1,1,""]},algorithms:{homology_mod2:[0,0,0,"-"],s_centrality_measures:[0,0,0,"-"]},classes:{entity:[2,0,0,"-"],hypergraph:[2,0,0,"-"]},drawing:{rubber_band:[4,0,0,"-"],two_column:[4,0,0,"-"],util:[4,0,0,"-"]},reports:{descriptive_stats:[12,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"2x2":2,"76rl01830":10,"abstract":0,"boolean":[0,2],"case":2,"class":[6,7,10],"default":[0,2,4,12],"final":0,"float":[0,2,4],"function":[2,4],"import":2,"int":[0,2,4],"long":[2,12],"new":[0,2,4],"null":8,"return":[0,2,4,6,12],"static":2,"switch":6,"true":[0,2,4,12],AND:9,ARE:9,BUT:9,FOR:9,For:[0,2,4,6,7,8,10],NOT:9,Not:2,One:2,SUCH:9,Such:9,THE:9,The:[0,2,4,6,7,10],Then:4,These:0,USE:9,Use:6,Uses:2,Using:2,__dict__:2,abov:[4,9,12],abs:2,ac05:10,accept:[2,4],access:[6,8],account:10,accuraci:10,aco5:10,across:4,action:0,activ:[7,8,10],add:2,add_edg:2,add_edges_from:2,add_el:2,add_elements_from:2,add_node_to_edg:2,add_nodes_from:2,add_to_column:0,add_to_row:0,added:[0,2,4],adding:2,addit:[0,2],adjac:[2,6],adjacency_matrix:2,adjust:4,advis:9,after:2,against:2,agenc:10,aggreg:12,aksoi:10,algorithm:[4,7,10],align:4,all:[0,2,4,6,8,12],allow:[2,4],alpha:4,alreadi:2,also:[2,6,12],alter:0,amount:4,anaconda3:8,anaconda:7,analysi:10,analyt:10,angl:4,ani:[2,6,9,10],annot:4,anoth:[0,4,6],apparatu:10,appear:2,appli:[0,2,4],applic:2,approach:4,appropri:4,ar1:0,ar2:0,arbitrari:4,arendt:10,arg:[0,2],arg_set:2,argument:[2,4],argumetn:4,aris:9,around:4,arr:0,arrai:[0,2],asc:0,aspect:12,assign:[2,4],associ:[0,2,9],assum:[2,10],attribut:6,author:10,auxiliari:[2,6],auxiliary_matrix:2,axi:4,band:4,base:[0,2,4,6],basi:0,basic:[2,6,12],bat:8,battel:[9,10],becom:2,befor:2,behavior:0,behind:4,being:0,belong:[2,6],below:8,berg:0,best:0,betti:0,between:[0,2,4,6,7],binari:[0,9],bipartit:[2,4,6],bkmatrix:0,bool:[0,2,4],both:[2,6,7,10],bound:0,boundari:[0,4],box:4,brenda:10,briefest:0,browser:8,bsd:8,build:[2,8],build_doc:8,busi:9,c_k:0,calcul:4,call:[4,6],can:[2,4,6,7],cannot:2,cardin:2,care:2,caus:[2,9],cell:[0,2,12],center:4,central:[0,12],centrality_stat:12,certain:2,chain:0,chang:[4,7,10],check:2,child:2,children:[2,6],chmod:8,choos:2,chosen:4,circl:4,classmethod:2,claus:8,cliff:10,clone:[2,8],close:0,code:9,cokernel:0,coldict:2,collaps:[2,4],collapse_edg:2,collapse_identical_el:2,collapse_nod:2,collapse_nodes_and_edg:2,collect:4,collumn:4,color:4,column:[0,2,4,6,12],column_index:2,com:8,come:8,command:8,comment:[7,10],commerci:10,comp:12,comp_dist:12,complet:[6,10],complete_registri:2,complex:[0,2,7,10],compon:[2,4,6,12],component_subgraph:2,comput:[0,2,4,12],concentr:4,conda:8,condit:[2,6,9],conflict:2,connect:[0,2,4,6,12],connected_compon:2,connected_component_subgraph:2,consecut:2,consent:9,consequenti:9,consid:[0,2],constitut:10,construct:[2,6],constructor:[2,4],contact:[7,10],contain:[0,2,4,6,7,10,12],content:[1,3,5,11],continu:8,contract:[9,10],contributor:9,control:2,conveni:4,convert:[2,4],convex:4,cooper:10,coordin:4,copi:[0,2,9],copyright:9,correct:4,correspond:[0,2,6],coset:0,could:2,count:[2,4,12],creat:[2,8,12],cross:4,csr:2,csr_matrix:2,current:[7,10],curvi:4,custom:4,cycl:[0,2,4],cyclic:0,damag:9,data:[0,2,4,7,9,10],datafram:2,dedup:2,deeper:2,defin:2,degre:[2,6,12],degree_dist:12,delet:2,demand:[7,10],densiti:12,depart:10,depend:2,depth:[2,6],descend:2,descript:0,descriptive_stat:11,design:[7,10],desir:2,determin:[2,4],develop:[7,10],deviat:12,diagon:[0,2],diagram:4,diamet:[2,6,12],dict:[0,2,4,12],dictionari:[0,2,4,6,12],differ:2,digraph:4,dim:2,dimens:[0,2],dimension:0,direct:[2,4,9],directli:[7,10],dirti:4,disabl:4,discard:2,disclaim:9,disclos:10,disconnect:4,discov:0,disjoint:[2,6],disonnecct:4,dist:12,dist_stat:12,distanc:[2,4,6],distant:4,distinct:2,distinguish:[2,6],distribut:[9,12],dlfer:0,doc:8,document:[8,9],doe:[2,4,10],doing:2,done:2,dot:0,draw:7,draw_hyper_edg:4,draw_hyper_edge_label:4,draw_hyper_label:4,draw_hyper_nod:4,drawn:4,drop:2,dual:[2,6,7],duplic:[0,2],dustin:10,e_1:2,e_2:2,e_end:2,e_n:2,e_start:2,each:[0,2,4,6,7,12],easier:4,eccentr:0,eccentricity_dict:0,echelon:0,edg:[0,2,4,6,7,12],edge_adjac:2,edge_adjacency_matrix:2,edge_diamet:2,edge_dist:2,edge_kwarg:4,edge_label:2,edge_labels_kwarg:4,edge_nam:2,edge_set:2,edge_size_dist:12,edge_uid:2,edges_kwarg:4,edgeset:2,edgess:2,edit:8,effect:2,either:[6,7,12],element:[0,2,4,6,12],element_subset:2,els:0,emili:10,emploi:2,employe:10,empti:[2,6],end:2,endors:10,energi:10,ensur:2,ent1:2,ent2:2,entiti:[0,3,4,6,7,9],entityset:[2,6],entri:[0,6],env:8,environ:7,equal:[0,2,6,12],equat:0,equival:[0,2],error:[0,2],evalu:2,even:9,event:9,everi:[0,2,6],exactli:6,exampl:[0,2,4,8],exceed:2,except:6,exe:8,execut:8,exemplari:9,exhibit:0,exist:[2,4,6],expand:4,expect:[7,10],express:[9,10],extens:8,facecolor:4,fail:2,fals:[0,2,4,12],favor:10,featur:0,ferrario:0,figur:4,file:[8,9],fill:12,fillna:2,find:4,first:[2,4],firstlevel:2,fit:9,follow:[2,4,8,9],fork:8,form:[1,9],format:12,found:7,fraction:[0,4],frequenc:12,frequency_distribut:12,from:[0,2,4,6,8,12],from_bipartit:[2,6],from_datafram:2,from_numpy_arrai:2,frozen:2,frozenset:2,fruchterman_reingold_layout:4,full:2,fullregistri:2,further:4,gener:[0,2,4,6,7,8,10,12],get_default_radiu:4,get_frozenset_label:4,get_line_graph:4,get_set_lay:4,github:8,give:2,given:[0,2,4,6],glossari:7,going:12,good:[0,9],gotten:2,gov:[7,10],govern:10,grant:9,graph:[2,4,6,7,10],graphic:10,grate:[7,10],greater:[0,2],group:0,guarante:4,handl:4,harmon:0,has:[2,6,10],hashabl:2,have:[0,2,4,6],header:2,helper:4,henc:2,herebi:9,herein:[9,10],hereinaft:9,high:10,higher:0,hist:12,hnx:[0,2,8],holder:9,homolog:1,homology_basi:0,homology_mod2:1,honor:2,howev:9,hpda:10,html:8,http:[0,8],hull:4,hyper:[2,4,6,7],hyperedg:[2,6],hypergraph:[0,3,4,6,7,10,12],hypergraph_homology_basi:0,hypernet:10,hypernetx:[2,9,10],hypernetxerror:[0,2],i_m:0,i_n:0,ideal:0,ident:[0,2,4],identifi:[0,2],ids:[2,4],illustr:4,im2:0,imag:0,impli:[4,9,10],impos:6,incid:[2,6,12],incidence_dict:2,incidence_matrix:2,incident:9,includ:[2,9],inclus:0,inde:2,independ:4,index:[0,2,6,7,8],indic:2,indirect:9,induc:[2,6],inf:2,infin:2,infinit:6,inflate_kwarg:4,info:12,info_dict:12,inform:[10,12],infring:10,inner:0,inseper:2,instal:7,instanc:[2,6],instanti:[2,6],instead:[2,4],institut:[9,10],instruct:8,integ:[0,2,4,6,12],intend:4,intens:2,inter:2,interest:0,intermedi:0,interpret:0,interrupt:9,intersect:[0,2,4,6],intuit:6,invers:0,invert:0,investig:10,invis:4,is_bipartit:2,is_connect:2,is_empti:2,isn:2,isomorph:[2,6],item:[2,12],iter:[0,2,4,12],ith:0,iti:6,its:[0,2,4,6,10],itself:[2,6],joslyn:10,jth:0,jupyt:8,jurisdict:10,kbasi:0,kchain:0,kchainbasi:0,keep:[2,12],kei:[0,2,4,6,12],kernel:0,keyword:[2,4],km1basi:0,known:2,kth:0,kwarg:4,kyle:10,label:[2,4],label_alpha:4,laberl:4,laboratori:10,larg:2,last:2,lastlevel:2,lawfulli:9,layer:4,layout:4,layout_hyper_edg:4,layout_kwarg:4,layout_node_link:4,layout_two_column:4,least:[2,4,6],left:[0,4],legal:10,len:12,length:[0,2,4,6],less:[0,2],let:2,level:[2,4,6],levelset:[2,6],liabil:[9,10],liabl:9,librari:[7,10],licens:7,like:[2,4],limit:9,line:[2,4],linecollect:4,linewidth:4,link:2,linv:0,list:[0,2,4,9,12],llinv:0,lmr:0,locat:[4,8],log:0,logfil:0,logic:0,logical_dot:0,logical_matadd:0,logical_matmul:0,longest:2,look:0,loss:9,lower:4,mac:8,made:2,mai:[2,6,7,8,9,10],make:[2,4,10],manag:10,mani:[2,7,10,12],manual:4,manufactur:10,map:[0,4],mark:10,mat1:0,mat2:0,mat:0,match:[0,2],materi:10,mathemat:10,matmulreduc:0,matplotlib:[4,8],matric:[0,4],matrix:[0,2,6,12],max:[0,12],max_depth:2,maxim:[2,6],maximum:[2,6],mean:[0,2,12],measur:0,median:[4,12],membership:[2,4,6],memori:[9,10],merchant:9,merg:[2,9],merge_ent:2,method:[0,2,6,7,10,12],metric:[7,10],min:12,minim:[0,4,8],minimum:[0,4],minu:2,miss:4,mod2:1,mod:0,model:7,modif:9,modifi:9,modul:[1,3,5,7,11],modulo:0,monson:10,more:[2,6],most:4,multi:[2,7,10],multipl:[0,2,6],multipli:0,must:[0,2,9],mxn:0,name:[2,7,8,9,10],nation:10,ncell:12,ncol:12,ndarrai:[0,2],necessarili:10,need:[0,4,8],neglig:9,neighbor:2,neither:[9,10],nest:[2,7,10],nested_incidence_dict:2,network:[2,7,10],networkx:[2,4],netwrokx:4,newuid:2,node:[0,2,4,6,7,12],node_diamet:2,node_label:2,node_labels_kwarg:4,node_nam:2,node_radiu:4,node_set:2,nodes_kwarg:4,nodeset:2,non:6,none:[0,2,4,12],nonempti:[2,6],nonexist:2,nonzero:6,nor:10,normal:1,northwest:10,note:[0,2,6],notebook:8,noth:2,notic:[7,9],nrow:12,num:12,number:[0,2,4,6,12],number_of_edg:2,number_of_nod:2,numpi:[0,2,4],nx2:4,nxm:0,obj:12,object:[2,6,12],obtain:[0,6,9],occupi:6,occur:2,off:2,offset:4,onc:8,one:[0,2,4,6],onli:[0,2,6],open:8,oper:10,opinion:10,optim:4,option:[0,2,12],order:[0,2,4],organ:10,orient:4,origin:0,other:[0,2,4,6,7,9],otherwis:[2,6,8,9,10],out:[0,4,7,9,10],output:2,over:[0,4,6],overlap:4,overview:7,own:[6,10],pacif:10,packag:[1,3,5,7,11],page:7,pair:[2,4,6],pairwis:2,panda:2,paper:4,parallel:4,paramet:[0,2,4,12],part:[4,10],particular:[2,9],partit:[2,6],pass:[0,4],path:[0,2,4,8],perform:[2,10],permiss:9,permit:9,person:9,pickl:[0,2],pip:7,place:2,planar:4,plot:4,pnnl:[7,8,10],point:4,poli:4,polycollect:4,polygon:4,pos:4,poset:2,posit:[2,4,6,12],possibl:[4,9],post:0,powershel:8,praggasti:10,pre:4,precis:6,prefer:2,preliminari:[7,10],prepar:10,prepend:2,present:2,preserv:2,principl:10,print:[0,12],prior:2,privat:10,process:[2,10],procur:9,product:[0,10],profit:9,program:10,project:[0,10],prompt:8,prop:2,properli:6,properti:[2,6],provid:[2,4,7,9,10],ps1:8,publish:9,purpos:[0,9],purvin:10,put:12,pytest:8,python:8,question:[7,10],quick:4,quit:2,radiu:4,rais:[0,2],rang:0,rather:12,ratio:12,rauga:10,read:4,real:2,reason:[2,4],recommend:[4,10],rectangular:[0,6],recurs:0,redistribut:9,reduc:[0,4],reduced_row_echelon_form_mod2:0,refer:[2,10],referenc:[0,2],reflect:[2,10],regist:2,registri:[2,6],relat:2,relationship:[0,2,7,10],releas:8,remov:2,remove_edg:2,remove_el:2,remove_elements_from:2,remove_nod:2,remove_singleton:2,render:4,rep:2,repeatedli:0,replac:[0,2],report:7,repres:[0,2,4,7,10],represent:4,reproduc:[4,9],requir:[7,10],reserv:4,respect:[0,2],respons:10,restrict:[2,6],restrict_to:2,restrict_to_edg:2,restrict_to_nod:2,result:4,retain:9,return_count:2,revers:[0,2],right:[0,4,10],rigor:4,ring:4,role:[2,6],root:2,row:[0,2,6,12],rowdict:2,rubber:4,rubber_band:5,run:8,s_betweenness_centr:0,s_centrality_measur:1,s_comp_dist:12,s_compon:2,s_component_subgraph:2,s_components_subgraph:2,s_connect:2,s_connected_compon:2,s_degre:2,s_distanc:0,s_eccentr:0,s_edge_connect:2,s_edge_diameter_dist:12,s_harmonic_closeness_centr:0,s_node_diameter_dist:12,same:[0,2,4,6],sampl:2,satifi:2,satisfi:[2,6],scipi:2,script:8,search:7,see:[2,4,6,8,12],self:2,sell:9,sens:6,sensibl:4,separ:2,sequenc:[2,6],serv:2,servic:[9,10],set:[0,2,4,6,7,10],set_nam:2,setsystem:2,shabang:8,shall:9,shallow:2,shape:2,share:[2,6],shortest:[0,2,6],shortest_path_length:2,should:[0,2,4],side:[0,2],similar:2,simpl:[0,2,6,12],simplici:0,sinan:10,sinc:[2,6],singl:[0,2,6,12],singleton:2,size:[0,2,4,6,12],small:[0,4],smaller:4,smallest:0,smith:1,smith_normal_form_mod2:0,snf:0,softwar:[9,10],some:6,sometim:4,sortabl:[0,2],sourc:[0,2,4,8,9,12],space:4,spars:2,special:9,specif:[2,6,10],specifi:[4,8],spectral:4,sponsor:10,spring_layout:4,squar:6,stack:4,standard:12,start:[0,2,4,12],stat:12,state:10,statist:12,store:0,str:[0,2],strict:9,string:[2,4,12],structur:[2,6,7,10],style:4,subgraph:[0,2],subhypergraph:6,subject:9,sublicens:9,submatrix:6,submodul:[1,3,5,11],subset:[2,4,6],substitut:9,success:6,suggest:[7,10],sum:0,summari:12,suppli:4,support:10,sure:2,surround:4,swap:0,swap_column:0,swap_row:0,system:[2,4,7,10],take:[2,4],target:2,techniqu:4,test:[7,8,10],text:4,textbook:4,than:[0,2,6,9,12],thei:[2,4],them:[6,7,8,12],theori:9,therefor:2,thereof:10,thi:[0,2,4,6,8,9,10,12],those:10,through:[0,4],thrown:2,time:2,togeth:[0,4],toplex:[0,2,6,12],toplex_dist:12,topolog:0,tort:9,track:[0,2,12],trade:10,trademark:10,tradit:[7,10],transform:[0,2],transpar:4,transpos:2,treat:2,truthi:2,tupl:[0,2],tutori:8,two:[0,2,4,6],two_column:5,type:[0,2,4,12],typic:4,uid:[0,2,6,12],uidset:[2,6],under:[8,10],undesir:2,uniqu:[2,6,12],unit:10,unpack:2,unweight:[2,6],updat:2,use:[2,4,8,9,10],use_rep:2,used:[0,2,4,6,9],usefulness:10,user:[2,8],uses:[2,7,10],using:[0,2,4,6,7],usual:4,util:5,v_1:2,v_2:2,v_end:2,v_n:2,v_start:2,valu:[0,2,4,6,12],variou:12,vector:0,veri:0,verifi:0,version:[7,8,10],vertex:4,vertic:[2,4],view:10,virtual:8,virtualenv:7,visual:10,wai:[2,4,7,9,10],walk:[2,6],want:0,warn:0,warranti:[9,10],weight:[2,6],well:4,whatsoev:9,when:2,where:[0,2,4,6],whether:9,which:[0,2,4,6,12],whitespac:4,whole:8,whose:[4,6],window:8,wish:8,with_color:4,with_edge_count:4,with_edge_label:4,with_node_count:4,with_node_label:4,within:[2,4,12],without:9,work:[0,4,7,10],would:[2,7,10],wrap:4,written:9,www:0,x_0:2,x_1:2,xor:0,xyz:0,yet:2,you:[4,7,8,10],your:8,z_2:0,zero:2},titles:["algorithms package","algorithms","classes package","classes","drawing package","drawing","Glossary of HNX terms","HyperNetX (HNX)","Installing HyperNetX","License","Overview","reports","reports package"],titleterms:{"class":[2,3],algorithm:[0,1],anaconda:8,content:[0,2,4,7,12],descript:7,descriptive_stat:12,draw:[4,5],entiti:2,environ:8,form:0,glossari:6,hnx:[6,7],homolog:0,homology_mod2:0,hypergraph:2,hypernetx:[7,8],indic:7,instal:8,licens:[8,9],mod2:0,modul:[0,2,4,12],normal:0,notic:10,overview:10,packag:[0,2,4,12],pip:8,report:[11,12],rubber_band:4,s_centrality_measur:0,smith:0,submodul:[0,2,4,12],tabl:7,term:6,two_column:4,using:8,util:4,virtualenv:8}}) \ No newline at end of file +Search.setIndex({docnames:["algorithms/algorithms","algorithms/modules","classes/classes","classes/modules","drawing/drawing","drawing/modules","glossary","index","install","license","overview/index","reports/modules","reports/reports"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["algorithms/algorithms.rst","algorithms/modules.rst","classes/classes.rst","classes/modules.rst","drawing/drawing.rst","drawing/modules.rst","glossary.rst","index.rst","install.rst","license.rst","overview/index.rst","reports/modules.rst","reports/reports.rst"],objects:{"":{algorithms:[0,0,0,"-"],classes:[2,0,0,"-"],drawing:[4,0,0,"-"],reports:[12,0,0,"-"]},"algorithms.homology_mod2":{add_to_column:[0,1,1,""],add_to_row:[0,1,1,""],bkMatrix:[0,1,1,""],coset:[0,1,1,""],homology_basis:[0,1,1,""],hypergraph_homology_basis:[0,1,1,""],interpret:[0,1,1,""],kchainbasis:[0,1,1,""],logical_dot:[0,1,1,""],logical_matadd:[0,1,1,""],logical_matmul:[0,1,1,""],matmulreduce:[0,1,1,""],reduced_row_echelon_form_mod2:[0,1,1,""],smith_normal_form_mod2:[0,1,1,""],swap_columns:[0,1,1,""],swap_rows:[0,1,1,""]},"algorithms.s_centrality_measures":{s_betweenness_centrality:[0,1,1,""],s_eccentricity:[0,1,1,""],s_harmonic_closeness_centrality:[0,1,1,""]},"classes.entity":{Entity:[2,2,1,""],EntitySet:[2,2,1,""]},"classes.entity.Entity":{add:[2,3,1,""],add_element:[2,3,1,""],add_elements_from:[2,3,1,""],children:[2,3,1,""],clone:[2,3,1,""],complete_registry:[2,3,1,""],depth:[2,3,1,""],elements:[2,3,1,""],fullregistry:[2,3,1,""],incidence_dict:[2,3,1,""],intersection:[2,3,1,""],is_bipartite:[2,3,1,""],is_empty:[2,3,1,""],level:[2,3,1,""],levelset:[2,3,1,""],memberships:[2,3,1,""],merge_entities:[2,3,1,""],nested_incidence_dict:[2,3,1,""],properties:[2,3,1,""],registry:[2,3,1,""],remove:[2,3,1,""],remove_element:[2,3,1,""],remove_elements_from:[2,3,1,""],restrict_to:[2,3,1,""],size:[2,3,1,""],uid:[2,3,1,""],uidset:[2,3,1,""]},"classes.entity.EntitySet":{add:[2,3,1,""],clone:[2,3,1,""],collapse_identical_elements:[2,3,1,""],incidence_matrix:[2,3,1,""],restrict_to:[2,3,1,""]},"classes.hypergraph":{Hypergraph:[2,2,1,""]},"classes.hypergraph.Hypergraph":{add_edge:[2,3,1,""],add_edges_from:[2,3,1,""],add_node_to_edge:[2,3,1,""],adjacency_matrix:[2,3,1,""],auxiliary_matrix:[2,3,1,""],bipartite:[2,3,1,""],collapse_edges:[2,3,1,""],collapse_nodes:[2,3,1,""],collapse_nodes_and_edges:[2,3,1,""],component_subgraphs:[2,3,1,""],components:[2,3,1,""],connected_component_subgraphs:[2,3,1,""],connected_components:[2,3,1,""],degree:[2,3,1,""],diameter:[2,3,1,""],dim:[2,3,1,""],distance:[2,3,1,""],dual:[2,3,1,""],edge_adjacency_matrix:[2,3,1,""],edge_diameter:[2,3,1,""],edge_diameters:[2,3,1,""],edge_distance:[2,3,1,""],edges:[2,3,1,""],from_bipartite:[2,3,1,""],from_dataframe:[2,3,1,""],from_numpy_array:[2,3,1,""],incidence_dict:[2,3,1,""],incidence_matrix:[2,3,1,""],is_connected:[2,3,1,""],neighbors:[2,3,1,""],node_diameters:[2,3,1,""],nodes:[2,3,1,""],number_of_edges:[2,3,1,""],number_of_nodes:[2,3,1,""],order:[2,3,1,""],remove_edge:[2,3,1,""],remove_edges:[2,3,1,""],remove_node:[2,3,1,""],remove_nodes:[2,3,1,""],remove_singletons:[2,3,1,""],restrict_to_edges:[2,3,1,""],restrict_to_nodes:[2,3,1,""],s_component_subgraphs:[2,3,1,""],s_components:[2,3,1,""],s_connected_components:[2,3,1,""],s_degree:[2,3,1,""],shape:[2,3,1,""],singletons:[2,3,1,""],size:[2,3,1,""],toplexes:[2,3,1,""]},"drawing.rubber_band":{draw:[4,1,1,""],draw_hyper_edge_labels:[4,1,1,""],draw_hyper_edges:[4,1,1,""],draw_hyper_labels:[4,1,1,""],draw_hyper_nodes:[4,1,1,""],get_default_radius:[4,1,1,""],inflate_kwargs:[4,1,1,""],layout_hyper_edges:[4,1,1,""],layout_node_link:[4,1,1,""]},"drawing.two_column":{draw:[4,1,1,""],draw_hyper_edges:[4,1,1,""],draw_hyper_labels:[4,1,1,""],layout_two_column:[4,1,1,""]},"drawing.util":{get_frozenset_label:[4,1,1,""],get_line_graph:[4,1,1,""],get_set_layering:[4,1,1,""]},"reports.descriptive_stats":{centrality_stats:[12,1,1,""],comp_dist:[12,1,1,""],degree_dist:[12,1,1,""],dist_stats:[12,1,1,""],edge_size_dist:[12,1,1,""],frequency_distribution:[12,1,1,""],info:[12,1,1,""],info_dict:[12,1,1,""],s_comp_dist:[12,1,1,""],s_edge_diameter_dist:[12,1,1,""],s_node_diameter_dist:[12,1,1,""],toplex_dist:[12,1,1,""]},algorithms:{homology_mod2:[0,0,0,"-"],s_centrality_measures:[0,0,0,"-"]},classes:{entity:[2,0,0,"-"],hypergraph:[2,0,0,"-"]},drawing:{rubber_band:[4,0,0,"-"],two_column:[4,0,0,"-"],util:[4,0,0,"-"]},reports:{descriptive_stats:[12,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"2x2":2,"76rl01830":10,"abstract":0,"boolean":[0,2],"case":2,"class":[6,7,10],"default":[0,2,4,12],"final":0,"float":[0,2,4],"function":[2,4],"import":2,"int":[0,2,4],"long":[2,12],"new":[0,2,4],"null":8,"return":[0,2,4,6,12],"static":2,"switch":6,"true":[0,2,4,12],AND:9,ARE:9,BUT:9,FOR:9,For:[0,2,4,6,7,8,10],NOT:9,Not:2,One:2,SUCH:9,Such:9,THE:9,The:[0,2,4,6,7,10],Then:4,These:0,USE:9,Use:6,Uses:2,Using:2,__dict__:2,abov:[4,9,12],abs:2,ac05:10,accept:[2,4],access:[6,8],account:10,accuraci:10,aco5:10,across:4,action:0,activ:[7,8,10],add:2,add_edg:2,add_edges_from:2,add_el:2,add_elements_from:2,add_node_to_edg:2,add_nodes_from:2,add_to_column:0,add_to_row:0,added:[0,2,4],adding:2,addit:[0,2],adjac:[2,6],adjacency_matrix:2,adjust:4,advis:9,after:2,against:2,agenc:10,aggreg:12,aksoi:10,algorithm:[4,7,10],align:4,all:[0,2,4,6,8,12],allow:[2,4],alpha:4,alreadi:2,also:[2,6,12],alter:0,amount:4,anaconda3:8,anaconda:7,analysi:10,analyt:10,angl:4,ani:[2,6,9,10],annot:4,anoth:[0,4,6],apparatu:10,appear:2,appli:[0,2,4],applic:2,approach:4,appropri:4,ar1:0,ar2:0,arbitrari:4,arendt:10,arg:[0,2],arg_set:2,argument:[2,4],argumetn:4,aris:9,around:4,arr:0,arrai:[0,2],asc:0,aspect:12,assign:[2,4],associ:[0,2,9],assum:[2,10],attribut:6,author:10,auxiliari:[2,6],auxiliary_matrix:2,axi:4,band:4,base:[0,2,4,6],basi:0,basic:[2,6,12],bat:8,battel:[9,10],becom:2,befor:2,behavior:0,behind:4,being:0,belong:[2,6],below:8,berg:0,best:0,betti:0,between:[0,2,4,6,7],binari:[0,9],bipartit:[2,4,6],bkmatrix:0,bool:[0,2,4],both:[2,6,7,10],bound:0,boundari:[0,4],box:4,brenda:10,briefest:0,browser:8,bsd:8,build:[2,8],build_doc:8,busi:9,c_k:0,calcul:4,call:[4,6],can:[2,4,6,7],cannot:2,cardin:2,care:2,caus:[2,9],cell:[0,2,12],center:4,central:[0,12],centrality_stat:12,certain:2,chain:0,chang:[4,7,10],check:2,child:2,children:[2,6],chmod:8,choos:2,chosen:4,circl:4,classmethod:2,claus:8,cliff:10,clone:[2,8],close:0,code:9,cokernel:0,coldict:2,collaps:[2,4],collapse_edg:2,collapse_identical_el:2,collapse_nod:2,collapse_nodes_and_edg:2,collect:4,collumn:4,color:4,column:[0,2,4,6,12],column_index:2,com:8,come:8,command:8,comment:[7,10],commerci:10,comp:12,comp_dist:12,complet:[6,10],complete_registri:2,complex:[0,2,7,10],compon:[2,4,6,12],component_subgraph:2,comput:[0,2,4,12],concentr:4,conda:8,condit:[2,6,9],conflict:2,connect:[0,2,4,6,12],connected_compon:2,connected_component_subgraph:2,consecut:2,consent:9,consequenti:9,consid:[0,2],constitut:10,construct:[2,6],constructor:[2,4],contact:[7,10],contain:[0,2,4,6,7,10,12],content:[1,3,5,11],continu:8,contract:[9,10],contributor:9,control:2,conveni:4,convert:[2,4],convex:4,cooper:10,coordin:4,copi:[0,2,9],copyright:9,correct:4,correspond:[0,2,6],coset:0,could:2,count:[2,4,12],creat:[2,8,12],cross:4,csr:2,csr_matrix:2,current:[7,10],curvi:4,custom:4,cycl:[0,2,4],cyclic:0,damag:9,data:[0,2,4,7,9,10],datafram:2,dedup:2,deeper:2,defin:2,degre:[2,6,12],degree_dist:12,delet:2,demand:[7,10],densiti:12,depart:10,depend:2,depth:[2,6],descend:2,descript:0,descriptive_stat:11,design:[7,10],desir:2,determin:[2,4],develop:[7,10],deviat:12,diagon:[0,2],diagram:4,diamet:[2,6,12],dict:[0,2,4,12],dictionari:[0,2,4,6,12],differ:2,digraph:4,dim:2,dimens:[0,2],dimension:0,direct:[2,4,9],directli:[7,10],dirti:4,disabl:4,discard:2,disclaim:9,disclos:10,disconnect:4,discov:0,disjoint:[2,6],disonnecct:4,dist:12,dist_stat:12,distanc:[2,4,6],distant:4,distinct:2,distinguish:[2,6],distribut:[9,12],dlfer:0,doc:8,document:[8,9],doe:[2,4,10],doing:2,done:2,dot:0,draw:7,draw_hyper_edg:4,draw_hyper_edge_label:4,draw_hyper_label:4,draw_hyper_nod:4,drawn:4,drop:2,dual:[2,6,7],duplic:[0,2],dustin:10,e_1:2,e_2:2,e_end:2,e_n:2,e_start:2,each:[0,2,4,6,7,12],easier:4,eccentr:0,eccentricity_dict:0,echelon:0,edg:[0,2,4,6,7,12],edge_adjac:2,edge_adjacency_matrix:2,edge_diamet:2,edge_dist:2,edge_kwarg:4,edge_label:2,edge_labels_kwarg:4,edge_nam:2,edge_set:2,edge_size_dist:12,edge_uid:2,edges_kwarg:4,edgeset:2,edgess:2,edit:8,effect:2,either:[6,7,12],element:[0,2,4,6,12],element_subset:2,els:0,emili:10,emploi:2,employe:10,empti:[2,6],end:2,endors:10,energi:10,ensur:2,ent1:2,ent2:2,entiti:[0,3,4,6,7,9],entityset:[2,6],entri:[0,6],env:8,environ:7,equal:[0,2,6,12],equat:0,equival:[0,2],error:[0,2],evalu:2,even:9,event:9,everi:[0,2,6],exactli:6,exampl:[0,2,4,8],exceed:2,except:6,exe:8,execut:8,exemplari:9,exhibit:0,exist:[2,4,6],expand:4,expect:[7,10],express:[9,10],extens:8,facecolor:4,fail:2,fals:[0,2,4,12],favor:10,featur:0,ferrario:0,figur:4,file:[8,9],fill:12,fillna:2,find:4,first:[2,4],firstlevel:2,fit:9,follow:[2,4,8,9],fork:8,form:[1,9],format:12,found:7,fraction:[0,4],frequenc:12,frequency_distribut:12,from:[0,2,4,6,8,12],from_bipartit:[2,6],from_datafram:2,from_numpy_arrai:2,frozen:2,frozenset:2,fruchterman_reingold_layout:4,full:2,fullregistri:2,further:4,gener:[0,2,4,6,7,8,10,12],get_default_radiu:4,get_frozenset_label:4,get_line_graph:4,get_set_lay:4,github:8,give:2,given:[0,2,4,6],glossari:7,going:12,good:[0,9],gotten:2,gov:[7,10],govern:10,grant:9,graph:[2,4,6,7,10],graphic:10,grate:[7,10],greater:[0,2],group:0,guarante:4,handl:4,harmon:0,has:[2,6,10],hashabl:2,have:[0,2,4,6],header:2,helper:4,henc:2,herebi:9,herein:[9,10],hereinaft:9,high:10,higher:0,hist:12,hnx:[0,2,8],holder:9,homolog:1,homology_basi:0,homology_mod2:1,honor:2,howev:9,hpda:10,html:8,http:[0,8],hull:4,hyper:[2,4,6,7],hyperedg:[2,6],hypergraph:[0,3,4,6,7,10,12],hypergraph_homology_basi:0,hypernet:10,hypernetx:[2,9,10],hypernetxerror:[0,2],i_m:0,i_n:0,ideal:0,ident:[0,2,4],identifi:[0,2],ids:[2,4],illustr:4,im2:0,imag:0,impli:[4,9,10],impos:6,incid:[2,6,12],incidence_dict:2,incidence_matrix:2,incident:9,includ:[2,9],inclus:0,inde:2,independ:4,index:[0,2,6,7,8],indic:2,indirect:9,induc:[2,6],inf:2,infin:2,infinit:6,inflate_kwarg:4,info:12,info_dict:12,inform:[10,12],infring:10,inner:0,inseper:2,instal:7,instanc:[2,6],instanti:[2,6],instead:[2,4],institut:[9,10],instruct:8,integ:[0,2,4,6,12],intend:4,intens:2,inter:2,interest:0,intermedi:0,interpret:0,interrupt:9,intersect:[0,2,4,6],intuit:6,invers:0,invert:0,investig:10,invis:4,is_bipartit:2,is_connect:2,is_empti:2,isn:2,isomorph:[2,6],item:[2,12],iter:[0,2,4,12],ith:0,iti:6,its:[0,2,4,6,10],itself:[2,6],joslyn:10,jth:0,jupyt:8,jurisdict:10,kbasi:0,kchain:0,kchainbasi:0,keep:[2,12],kei:[0,2,4,6,12],kernel:0,keyword:[2,4],km1basi:0,known:2,kth:0,kwarg:4,kyle:10,label:[2,4],label_alpha:4,laberl:4,laboratori:10,larg:2,last:2,lastlevel:2,lawfulli:9,layer:4,layout:4,layout_hyper_edg:4,layout_kwarg:4,layout_node_link:4,layout_two_column:4,least:[2,4,6],left:[0,4],legal:10,len:12,length:[0,2,4,6],less:[0,2],let:2,level:[2,4,6],levelset:[2,6],liabil:[9,10],liabl:9,librari:[7,10],licens:7,like:[2,4],limit:9,line:[2,4],linecollect:4,linewidth:4,link:2,linv:0,list:[0,2,4,9,12],llinv:0,lmr:0,locat:[4,8],log:0,logfil:0,logic:0,logical_dot:0,logical_matadd:0,logical_matmul:0,longest:2,look:0,loss:9,lower:4,mac:8,made:2,mai:[2,6,7,8,9,10],make:[2,4,10],manag:10,mani:[2,7,10,12],manual:4,manufactur:10,map:[0,4],mark:10,mat1:0,mat2:0,mat:0,match:[0,2],materi:10,mathemat:10,matmulreduc:0,matplotlib:[4,8],matric:[0,4],matrix:[0,2,6,12],max:[0,12],max_depth:2,maxim:[2,6],maximum:[2,6],mean:[0,2,12],measur:0,median:[4,12],membership:[2,4,6],memori:[9,10],merchant:9,merg:[2,9],merge_ent:2,method:[0,2,6,7,10,12],metric:[7,10],min:12,minim:[0,4,8],minimum:[0,4],minu:2,miss:4,mod2:1,mod:0,model:7,modif:9,modifi:9,modul:[1,3,5,7,11],modulo:0,monson:10,more:[2,6],most:4,multi:[2,7,10],multipl:[0,2,6],multipli:0,must:[0,2,9],mxn:0,name:[2,7,8,9,10],nation:10,ncell:12,ncol:12,ndarrai:[0,2],necessarili:10,need:[0,4,8],neglig:9,neighbor:2,neither:[9,10],nest:[2,7,10],nested_incidence_dict:2,network:[2,7,10],networkx:[2,4],netwrokx:4,newuid:2,node:[0,2,4,6,7,12],node_diamet:2,node_label:2,node_labels_kwarg:4,node_nam:2,node_radiu:4,node_set:2,nodes_kwarg:4,nodeset:2,non:6,none:[0,2,4,12],nonempti:[2,6],nonexist:2,nonzero:6,nor:10,normal:1,northwest:10,note:[0,2,6],notebook:8,noth:2,notic:[7,9],nrow:12,num:12,number:[0,2,4,6,12],number_of_edg:2,number_of_nod:2,numpi:[0,2,4],nx2:4,nxm:0,obj:12,object:[2,6,12],obtain:[0,6,9],occupi:6,occur:2,off:2,offset:4,onc:8,one:[0,2,4,6],onli:[0,2,6],open:8,oper:10,opinion:10,optim:4,option:[0,2,12],order:[0,2,4],organ:10,orient:4,origin:0,other:[0,2,4,6,7,9],otherwis:[2,6,8,9,10],out:[0,4,7,9,10],output:2,over:[0,4,6],overlap:4,overview:7,own:[6,10],pacif:10,packag:[1,3,5,7,11],page:7,pair:[2,4,6],pairwis:2,panda:2,paper:4,parallel:4,paramet:[0,2,4,12],part:[4,10],particular:[2,9],partit:[2,6],pass:[0,4],path:[0,2,4,8],perform:[2,10],permiss:9,permit:9,person:9,pickl:[0,2],pip:7,place:2,planar:4,plot:4,pnnl:[7,8,10],point:[0,4],poli:4,polycollect:4,polygon:4,pos:4,poset:2,posit:[2,4,6,12],possibl:[4,9],post:0,powershel:8,praggasti:10,pre:4,precis:6,prefer:2,preliminari:[7,10],prepar:10,prepend:2,present:2,preserv:2,principl:10,print:[0,12],prior:2,privat:10,process:[2,10],procur:9,product:[0,10],profit:9,program:10,project:[0,10],prompt:8,prop:2,properli:6,properti:[2,6],provid:[2,4,7,9,10],ps1:8,publish:9,purpos:[0,9],purvin:10,put:12,pytest:8,python:8,question:[7,10],quick:4,quit:2,radiu:4,rais:[0,2],rang:0,rather:12,ratio:12,rauga:10,read:4,real:2,reason:[2,4],recommend:[4,10],rectangular:[0,6],recurs:0,redistribut:9,reduc:[0,4],reduced_row_echelon_form_mod2:0,refer:[2,10],referenc:[0,2],reflect:[2,10],regist:2,registri:[2,6],relat:2,relationship:[0,2,7,10],releas:8,remov:2,remove_edg:2,remove_el:2,remove_elements_from:2,remove_nod:2,remove_singleton:2,render:4,rep:2,repeatedli:0,replac:[0,2],report:7,repres:[0,2,4,7,10],represent:4,reproduc:[4,9],requir:[7,10],reserv:4,respect:[0,2],respons:10,restrict:[2,6],restrict_to:2,restrict_to_edg:2,restrict_to_nod:2,result:4,retain:9,return_count:2,revers:[0,2],right:[0,4,10],rigor:4,ring:4,role:[2,6],root:2,row:[0,2,6,12],rowdict:2,rubber:4,rubber_band:5,run:8,s_betweenness_centr:0,s_centrality_measur:1,s_comp_dist:12,s_compon:2,s_component_subgraph:2,s_components_subgraph:2,s_connect:2,s_connected_compon:2,s_degre:2,s_distanc:0,s_eccentr:0,s_edge_connect:2,s_edge_diameter_dist:12,s_harmonic_closeness_centr:0,s_node_diameter_dist:12,same:[0,2,4,6],sampl:2,satifi:2,satisfi:[2,6],scipi:2,script:8,search:7,see:[2,4,6,8,12],self:2,sell:9,sens:6,sensibl:4,separ:2,sequenc:[2,6],serv:2,servic:[9,10],set:[0,2,4,6,7,10],set_nam:2,setsystem:2,shabang:8,shall:9,shallow:2,shape:2,share:[2,6],shortest:[0,2,6],shortest_path_length:2,should:[0,2,4],side:[0,2],similar:2,simpl:[0,2,6,12],simplici:0,sinan:10,sinc:[2,6],singl:[0,2,6,12],singleton:2,size:[0,2,4,6,12],small:[0,4],smaller:4,smallest:0,smith:1,smith_normal_form_mod2:0,snf:0,softwar:[9,10],some:6,sometim:4,sortabl:[0,2],sourc:[0,2,4,8,9,12],space:4,spars:2,special:9,specif:[2,6,10],specifi:[4,8],spectral:4,sponsor:10,spring_layout:4,squar:6,stack:4,standard:12,start:[0,2,4,12],stat:12,state:10,statist:12,store:0,str:[0,2],strict:9,string:[2,4,12],structur:[2,6,7,10],style:4,subgraph:[0,2],subhypergraph:6,subject:9,sublicens:9,submatrix:6,submodul:[1,3,5,11],subset:[2,4,6],substitut:9,success:6,suggest:[7,10],sum:0,summari:12,suppli:4,support:10,sure:2,surround:4,swap:0,swap_column:0,swap_row:0,system:[2,4,7,10],take:[2,4],target:2,techniqu:4,test:[7,8,10],text:4,textbook:4,than:[0,2,6,9,12],thei:[2,4],them:[6,7,8,12],theori:9,therefor:2,thereof:10,thi:[0,2,4,6,8,9,10,12],those:10,through:[0,4],thrown:2,time:2,togeth:[0,4],toplex:[0,2,6,12],toplex_dist:12,topolog:0,tort:9,track:[0,2,12],trade:10,trademark:10,tradit:[7,10],transform:[0,2],transpar:4,transpos:2,treat:2,truthi:2,tupl:[0,2],tutori:8,two:[0,2,4,6],two_column:5,type:[0,2,4,12],typic:4,uid:[0,2,6,12],uidset:[2,6],under:[8,10],undesir:2,uniqu:[2,6,12],unit:10,unpack:2,unweight:[2,6],updat:2,use:[2,4,8,9,10],use_rep:2,used:[0,2,4,6,9],usefulness:10,user:[2,8],uses:[2,7,10],using:[0,2,4,6,7],usual:4,util:5,v_1:2,v_2:2,v_end:2,v_n:2,v_start:2,valu:[0,2,4,6,12],variou:12,vector:0,veri:0,verifi:0,version:[7,8,10],vertex:4,vertic:[2,4],view:10,virtual:8,virtualenv:7,visual:10,wai:[2,4,7,9,10],walk:[2,6],want:0,warn:0,warranti:[9,10],weight:[2,6],well:4,whatsoev:9,when:2,where:[0,2,4,6],whether:9,which:[0,2,4,6,12],whitespac:4,whole:8,whose:[4,6],window:8,wish:8,with_color:4,with_edge_count:4,with_edge_label:4,with_node_count:4,with_node_label:4,within:[2,4,12],without:9,work:[0,4,7,10],would:[2,7,10],wrap:4,written:9,www:0,x_0:2,x_1:2,xor:0,xyz:0,yet:2,you:[4,7,8,10],your:8,z_2:0,zero:2},titles:["algorithms package","algorithms","classes package","classes","drawing package","drawing","Glossary of HNX terms","HyperNetX (HNX)","Installing HyperNetX","License","Overview","reports","reports package"],titleterms:{"class":[2,3],algorithm:[0,1],anaconda:8,content:[0,2,4,7,12],descript:7,descriptive_stat:12,draw:[4,5],entiti:2,environ:8,form:0,glossari:6,hnx:[6,7],homolog:0,homology_mod2:0,hypergraph:2,hypernetx:[7,8],indic:7,instal:8,licens:[8,9],mod2:0,modul:[0,2,4,12],normal:0,notic:10,overview:10,packag:[0,2,4,12],pip:8,report:[11,12],rubber_band:4,s_centrality_measur:0,smith:0,submodul:[0,2,4,12],tabl:7,term:6,two_column:4,using:8,util:4,virtualenv:8}}) \ No newline at end of file diff --git a/hypernetx/algorithms/s_centrality_measures.py b/hypernetx/algorithms/s_centrality_measures.py index fd3d5ec6..84f7d0b2 100644 --- a/hypernetx/algorithms/s_centrality_measures.py +++ b/hypernetx/algorithms/s_centrality_measures.py @@ -32,10 +32,12 @@ def s_betweenness_centrality(H, s=1, normalized=True): A dictionary of s-betweenness centrality value of the edges. ''' + # Confirm there is at least 1 s edge for which we can compute the centrality # Find all s-edges #M,rdict,_ = H.incidence_matrix(index=True) #A = M.transpose().dot(M) + A, coldict = H.edge_adjacency_matrix(s=s, index=True) A.setdiag(0) A = (A >= s) * 1 @@ -66,8 +68,10 @@ def s_harmonic_closeness_centrality(H, edge=None, s=1): If edge then a single value is returned. ''' + # Confirm there is at least 1 s edge for which we can compute the centrality # Find all s-edges + if edge and len(H.edges[edge]) < s: return 0 @@ -89,6 +93,7 @@ def temp(e, f): # confirm there are at least 2 s-edges # we follow the NX convention that the s-closeness centrality of a single edge Hypergraph is 0 + output = {} if not bool(Es) or len(Es) == 1: output = {e: 0 for e in edges} @@ -123,6 +128,7 @@ def s_eccentricity(H, f=None, s=1): returns the s-eccentricity value of the edges, a floating point number If edge=None a dictionary of values for each s-edge in H is returned. If edge then a single value is returned. + ''' if f: if isinstance(f, Entity): From 672abb0bc9bdaaa9cc84b3f02fbd21c719901ee7 Mon Sep 17 00:00:00 2001 From: Brenda Praggastis Date: Tue, 8 Sep 2020 14:08:05 -0700 Subject: [PATCH 3/3] updating docs --- .../.doctrees/algorithms/algorithms.doctree | Bin 125156 -> 127875 bytes docs/build/.doctrees/environment.pickle | Bin 208485 -> 209621 bytes .../algorithms/s_centrality_measures.html | 17 ++++++++++++++++- docs/build/algorithms/algorithms.html | 16 +++++++++++++++- docs/build/algorithms/modules.html | 5 ++++- docs/build/searchindex.js | 2 +- hypernetx/algorithms/s_centrality_measures.py | 17 ++++++++++++++++- 7 files changed, 52 insertions(+), 5 deletions(-) diff --git a/docs/build/.doctrees/algorithms/algorithms.doctree b/docs/build/.doctrees/algorithms/algorithms.doctree index 3d23841ad24a38f15f2882653da8b2e945751a7f..8c35281041a1aa25e53d579f943979369db26658 100644 GIT binary patch delta 6543 zcmcIodvH|M8P9hKVQ(G~8UjiJxeJ)xY&M%j0*ykjJT%dmsDsZamd)-ZcdubL?rwlk z>iQU`*sc`3D@UDT4B`VV1z+9z7^;#MDy1z`YXypbS_!9V(a=iIxGBm``A zCUbM|Ip6txzwdRvv**Ku%$IG^{f^a%Z-bF0EOt2BTqb zcOcrQw5i@mZ&-~av~kN4T50?Yv-c+MN_;=z)W+(2DsytQsrnn0#-{7t#pCgHH;sTc zMk|X8HL-+N-YWHWYU`@ZRX6?+a&m4^l`b`?lH#@a8us>R%1SjF4)`KUG^9jotdA9; zu;Nv;z8*C!q&oYQ-bf(Wr39i8l=FpxLDd&k{rSGo%AQaVt%-P)YqdZ`!9TArM#J5K zh^G1#TuNWPQCc3=R3)OQ{w}q~>({+LHR$V8R(g@b8pRtVxL_n2?)9aFeW5V=237cJ zxgZl-!EwYgkAhYqY!C^min=Bc!L^l^sA*7sD2OshEv)t+9Mbhh1EHYtXr$?y_tS*-9C}Q7qEY1>&apxL~M5+R^9r!i+FE(N_pT&V+qyOfOn9OH! zV21w|jh4#^+$jE#+9=w!^7h_NT`J1Sv9^f#7)*C|WDw4m4pkcV${8`hS#uTcC8hBz zzQ$rmMf1$4jksTYOw?}EAoiwOMSBJv4DG^_QZ#Js}xWxv#w3<-ZuV$)OR(rc|i+J)cz4{7e zi8tz1mihu7gyZoYSkXyAE}Mh z&yLM)Y^*`qn!36RXV=%%xvcFcKIeZjJ6(R~1`r$OI7-0JMoqw1@|CP&x#tZamy9t#cU9HP=dg4#U2t zgKc~m8l<_Xc0QCzt7xpk=x>-zwCrtgesLKx@oIKFY|UJj(90ag`wdfA$0JZ%J{M ziE&)wx-Iaa{Fac|=U}(5g;^8IED-YUuaI-)j7fWh$Ts>X95>C8yya0)K>8b(C^<<} zsilRu^f-H=AC^mB@cH6@3xwmAShD#smN%KjcQp#jLq5x_sicEOO`o@cz7a; zcW@k=X-o^Z*x0D%4l#(3FBNv11}zd_snB4jsb)Ky(N)>W^2X6h_RIa4e;b{~HJ?u| z6i0LsDx>1P1?&e;LM)fg?d<&)@UX_GV1x9elh==JD>282v)}E22U!2paGCUylUGrp zHHA@sk=1R7i*j4gb*!GjdD31dRTAuBuWpA%>23Zc?Qx2_I%Z8`a2v8=4n707NMAa6 z34MX~StXQ2om4`nXiSvQRve-d+JX$zCA7tvE}J77?nRmHk~25aO-F+8`57nWO}L*M1CV=)Y~=oNi}K^~qgPW>2Lyc6m%TY7gw zwcI9fTB|6(t!y#DD3_aYKAkPF3l___iY2#HS=nNWQ%>K+aja}apa>U62dN<>Tj&%Q^wPmScF#%r#e0Dz37)3@r+$KFBuhgK`#s9xjzP3YZN;`O(k6 zA93s%W>T&ffWy6nPP*m=IE2KC_Q56cvjTDZNKPVRPgumLq>}qzgc!)Li8ZebWkH3K z%<|F`+)GwHW!Sq_h?(`Yo{L$oT{V(xi3_=wqHip8E0fHnRz_fI&8adL9<>{vyiib- zop7l#{Gy7=P||m^g};Ck((X!j=oQ#uob0f(Q!m3-sn{i2SD`D36SzlKxJ273bP3I< zWx7kWt=89|GF^61&j#MY{c?FLlu9)&HuxGe!Gi2D>TGaj)>yiqWow{*1}jLkg!PYy zY2f3_9%z{_`kEbiVNt?zK5RVNFhwfFAu7r|q?#_uJXg9X?KqQBlyas`yswRU9X-nf&=z*46Djba4Orqs2TzO<6xc$ zxZn_%n_~7vnl$yGjM+Et+X7zO$AaOjy%<77%Xsg;Zy5p)?mWY?)EmP`} z3@@h4OR`jgXA9sZOG@AZJlQ#xB{1PN%CRk}pB&Z?LcAE`ikR)U@TD9QzFApK*J)#E zKh@cS18^7U$=44+>li%V79NEDF?kQ6p#C6x?rr#WTNl0i>2WJPZl(vFE5(D_qs|{x zlRAHFB$4~^(Hob8Uc3{+pM(**(bFGdulxztRug19him63>p8-DzIwe*%iDXk3R>_W zyXhTl**R{OdQn2$pmr7cA*i zAz0F8#98V(Va104#yMa~4yqtO;jDQwy)W7MF2q6lj+^>trPSnR=N$%3y4sCr5_fUC zSkOfO=n%wrzl|qAX8j+6js5d5l+;Z_I`Le(ZA-M~(QY+QEE;x(#Mw@LzMG%)T94pQ zh;E@20-KM5lN~<-Q?tP2QNe6!u+t~t$I^Ne>|O+Gt0YpREvFr7zMI)kLYK5ntds|k zHx6IrW(Duz(e3#x7trKz7sv}%;CMVQg7<|!HNk%jSiYDrn*P=a83Yap0tIhb1TYcm z4#U;b5l&%(83md~3UjF0Rxm3HLn%4VQL3fu>f%Wgk` zx;|-y@fHh`_-ZWjM`e-ES@5KwIHEREX(%om9-;8n$&UOL%yT%Nz>04+?n`Wgs$)IUAY7W!S=wRCPEGC)xKCD>`&38N!q)b~*uk{P= zCaY4}lZl*}{KJulBtP7dM*beX3a2$?I;|jEPlnTm!Dkc)Je)$7H(M?gx$zXA;kjWs ZkR(QM;Oy)o$uu*wNV0ga$3B83{{=7R-Vgu) delta 4257 zcmb7Ge{fXQ74~}x$=hTTvI##lK|+$rW|svM3L~~91Vn>OXvPfCDoQnAaDA;55<->! zurxCcBe7|CTTivdfK*70cB%|67!(7Vj!Ym#6ztgA5R!&YOCdvrnW8hj=ic{r-^-@V z^q2bt6AvK7;W^ZviCYoi z?-p%Xa9Dsm6!X6`%=URxm|nrRa7)&4L8~@guqF~NS`#sj`^|xQQ)$;*D4jMeJdNR? zQ4c{p*Er$iAMO4v`k~)fB3<96ZS4q}S+}HS7`+@etqNkr3Oc(NtMv6M=#j*rR2j5s zAAY4jse*n;i#t$AWo?+?wU9g_XfvCOCe^E;75qn4vezGdq60I4U(1M`=h&5JlkkeA zJE`w?co-ehpS4#Z?6kw8>t2NqT2~2e>BMUE$SBYIDoR+t>cm?1*1iV6O(K`e3UhvGqsj{K=FiHoB|B7@i#NwqH?B1rgfF-)@{>p)JRzJCP8EmHoM>vL)vx0_ zAbRt4%+|kBc-JL*o;&9(vF$bC7tqlXv;TS?E&4s4)iVQP!(78l{hd~Qb*sKUYIzMM z9xIh=CF7*RnE#fW=~gPED*xDln2UcJqFtXr&v3Pg+5HzkefA0Rw2FXPb7hLxXyf)! z2V~}dzL56(0Z%2fkp}L;ZM5Fi}ayL1a_co2b+t z2`FjB1C4b7DXq2pQKVh-Q%etWv4xXXnnFFD-H$ua6gO%00VTawm(49R*A7Z%og8k- ztV1o`xCa}x^@0>@?G`TDQK9C3;3svP!4j@7dC|7O(_#HW%6Lbv3~4 zm1`-*fqO;awnme>kPN{_KP=dU6m(Exlv<5$t?~)*V&Ru;#%d@abS0a=<1p^lD-=w5 zBEw7p@(qbzX!Y`Z1({eWQK-k?!Jh=R;76#?S1Zi>^ipIsdWTdwVKgJYmQ>rE5)k>`JzLRKl%VAJo^eL`+dBu9SJJ=c5$}jM(@y0 z29eYSM7`8%Ja zbWaIZEZvFHCZ*dYOf204BAK{!4+P`VJ;etdACm`TS#w50y3zdO7=?c4OsSGZG|-DV z-Y7?@DOpaddeNlctNhi{f3xN10a?xtQAW|{R!`q`0;ly_75@-ZwFaiOhzI6_Y%VIZ zdfJ8%$E{*`@QmBxubjjZ(cynTi4ts;7`c|}EO3_e7O}Me*hkfU2w}Snn`%u~_F3DA z5NiVU^`Tb(jUxPfB4NgSPNLX-yk(}d`5jv~$S`}Lj+<9Q;`AIh)vxvAsx9UZ6t`m% z-4?U8ZMI-{L}jefiGKJI4naSo)_k0p4-2l}mCup!@?qe^GR&T;ht#6jsl}(NyQ^YT zH8sTgoM=x~>u{q_pFtAzDIwW$lc@EqxZizr>@2osykAN<`t+wrOF~_=^)s|5 zrBn#Nv4C#>D|(h>@^?D_@FP+E@CY;H4=ciuKl3?cp7?2O_H3wqyl(T88|xbQMPpRZ zvH@%@W}s@he!E<|U9Q`1@WSfGa6X4FpnnbEL2X}%mY>5hpWK%38zYU;J3=&LP>k|4 zIx&a>j{5E(@=7Hyepo9?Jf#&S7QLioaKgr1C&pZfk+V-W*nOGdp z!VF<=PHFf-WBt0ih%A9!rHMD9P&LuPVRMW_`X-x$csKS9;a>dQ#e&^}#SlL>rgI(T z5shWRGu391>|o&>jv_={)5#7NZ7~*}7i<=)5}hs%?EL>Yq}`B1+L)8=iSfWO`6=^E z)0&f6ei7qt>b{66H*=B>-1$Nmj%3coK+-?Ald(&B$(0VfMLJP_VEpfr@&#m<)Y<+C z7qt+FyZzJ1_fM<+Q{^Y8lf5t~wvG3V6W*zVMEJ2fD2~Gy#^61b@oMotmTuGC8#=0& ou#ZzBi(*@N%4fSIQq7*2MA$h_CFi;&;!M>k5f=rjxPrU>3tJ&0iU0rr diff --git a/docs/build/.doctrees/environment.pickle b/docs/build/.doctrees/environment.pickle index c7fca4ddb50c611f85084cd4bf169204f124a021..ce4425f6201401c8873fe2e9a1879ac27e93a537 100644 GIT binary patch delta 14341 zcmbVT33yahmgc@JWO+%b>}0Kwkd0JjVM`z^0R*)y0c{Wzh(%H)^{Av`RRs(*L}Y9T zlw>&t57`89MV0^x0%29aurwg;0tiCe?R57@BepYb_p~zS+*eh3Nu2MSZ}KH~`OmrM zoO|wm-_0Mt6hHl=81RDs+W*em8=xBi4FfWsim0@k7Fuen@@s6B^;WaP?FzRoFxwYc z%nS1^wUy@Q-LAftT8GnQwYptFRaTqBVX`;4T`?wWmCbH(R@XT4yOM5Kgxy?cvpb<< zKr-wb5HldaBgCi2qYuSeEfwZkhj~9se^+QcEA;6zsqFJl|FzvU`+MnJSMK)1Ql~H1 z{zHp&(wEzNYrS;Ampik3zVu;N?gyiE#+Uo}i^rw&zFcR+H_~Ze?p$<$ba7Z$cG-RD zBVX=(-an*|yK*(lrBlA#mAf0jlsPh(OmB8)y9UFvS&8uH%mkLnQztURpd%|4%CmHk zmNhE4g;xYQp*bg8aHT$Ps*&7*P@5ee;#_De zudrF`Yigl2yBLhwv4ZPSxRad@WjT|v#3-oA&h~4OF2doQB=!+}o|D>_Z0)WuP|*i( z=MLhwCFkaoHuz_5Qt(AjJ+fP;roq@j26lG8YtRw~kL0IAo~|D5V!Xi^1J`s@*ac`W z8~|Zclfj~&0VPElQ2IRg0O_Vwhdk04ip_)niDNijcoum}Cs&t7`-F!*YMiEZI3(#td0 zMxToH0nj>h13T&=aksO>UNSq#Q&>IWy#OejHVtl1Dr0wi%!?k*Ww(6HH@Y)VhZi4t zm<7PHCniC9xdzf7)iVKeO7$OfXPyR^W(;LHKIYjoL*R^|KMrnhfpnhon37gH9L78y zBB1$H*R@<2)ivx{8x9*Sx`Wi-uF^oiMNzEWD@B+UNG=uT1;G8%ICyo@5LjE;559Rk zTUZeYduQ1~$;HwO zY-S-8*kU2II1+NF>sT}*1{sIZEPxZEo_*ufEIgjUz9!8$dc8im z=_~WjggTr&v(R5mngs6}l%@-ZW%G)mU_^)z8iY+}gO5x)R^VZY1jF1^rt`9}T%JN# z3t2%pR+1s2;#u}9A9H6#5}WE}79J1kUi%^JJglqyHe+!RcE2SQygza%-&X4(A(zd81jA)F#8y&v}|Jkj-}_bKln=Bfp+N%!=CS)1e z|N1ezkNH|%BD49JtzKqtRqiNNxy7rpWs1^?cH6b+0x|- zr){{xrm@dB-}YxR*i|3jWf)rz>_0se4dg9IWZ(O!_mG;Zo{bjH>IZ!nE>VquG2Z6u zSQs77r=lXI`NBeg%^3;W34y}BVBQGdqBW%)xU2vdxp`ylIRE2HIjblJb~c0xlSAOS ziir^G$PgY2fjfpW;gOJ@z42rC-J;=wGvt@&#J=#};uysk&%9{vG6scFhnh&p=r*Sf zHyYW(W<_V>0zR;W4T@elgeF9x!%O5dqHstd9tZ)=*fL>%2=5!8G|muick%t(3qypP z3g7i^d^l+d{-L~ri3=iO&dgxYz1Ux1p}e9$`*^*LjwX<`ZnAb1v@VaEMtdPc5Z?$H z7~cgM0{9jPbF}|41oF)f=4j`G5$$zxeV|P)a?-2$Q(ZZlu)1SxJFJOsMVsoYvkiUftKX+>sG>646^~~u zs9zDs&ce$pilOMuNcen3CXXXlX7Ko-m1#V_-INesZL6_aZB-5Bb4?D50}9@ZhWAzu z<>b`W2|<=xr`cX-H$(oLF)+U=0Um1#Tw*px>{k6bB*VDt1HaM;))C8Tl?j($(6!7 z;fO02!#X)0es(2d>aIH;&c7TEV_%NK+_L6OSoCrT;V)+fRakAcX1C;JO5?CjVGA`| z%{91Dc5wQd%!qmQR;%4yWpOz142xx!trRz$fDR54qr4=v1MyAL2T)VspOVX7(UZdL}+tns9M?a7QKhp&>HSXvcB3B52IQ$ z5cSGi*-G-(wdP^?Ve23a@3m5?ls59nBW+5>2Er8ZhplaW5qrCBB5}2i#BkXfqG&KR z7c#sqbwOq*dDj(CVKq4%ut!dZ+d%GnutAThAbCog5QN#C?tFRUdVz{#5;nM%)L6{l zb(eVfr>&)GVoABgEl~1}wGU(X*R|s@Ong-j&#n_ORkO~B;gNL{FkH4K9%gHeET>lV;$u03vw|*d|$kwsz1LS)fgis$L zIk>CX=#9kS@6X$s>=Q3A#mkg=Y$G>zr&}-IkcCJ^ploUOp?_}U=vSNca9~3?((fYc zs#dP-!G_TYjNUjDL+8dZ7{13tR2gKmSDNi)_Pw@vII<~OZrLRGdm48rWvGo5S~{k_ z+Ej|+*3AVFu{l8gc9THP+PZl}kh!u7kAo;@>*g|qe!rQjPuBF?5~|e6yoDNi=aym& zNwcHcRL32b`05CRZp!+;4$C5rppOfkwmPf%c`lP0Kd{E^thQCUe}fkD z5RHOum!iX!Sn16mQkRgw>I7d0PxKIsy%*ETHIm4W719`l5TaKqd77Sh)3Bj+$gz*!+M`au|zZS<;PJb=a!x;>hUke2Z z|8~6=q{33*^oq!~?Gb^B0EpS1!(~p{p2Fi7wreSl>+8L8>Q=e_aDRLMAh&Y*Uk-oS zKA4??l-Gx2IQ{h!3|n3=#<27CQVav%n1G?-jUo(}zCk<(-XNau-WbP2J&gM@5?lQg zEO?Xf_BRt7`L%*lt$L|}FCE#^ix}hO0=7u?((0v6PPg=aFXTio`1}vJrRt@j{#-)S;t+t6ONY&R5FLf4BcEFNtQSE)uz;pHdxNH;Q6_qdTY4 z9lAiyROryjd%qQ;;L>NwN(G{Kj>h`@>vL_e*JG)m*%cF^tFYD7;SyiVo1zr9?##s6 zpWT_8$OZLtC?-_cYHQ6EPBYDL*lEOFDKVTL;?VgP7fuX&4#anrq zAS~0>AXM8hPi?zk&KRgD_xaUZRdNb}oGEIqrOsr>TVAskjjXiLu2E6=-LAAG&Z2Qx zYH+sJcJCTzK(~81-glXI>(~bXy9>fPu(MQ`N=Gr0j=|;Kna>=?WVWQjU80d+OF(m zML51^(1?S`B2iGi6s!LcED`(AJ)m zbd}g?Y)QYv6iWM?0DhDE1-#WhFo-5mJYt-K@7kkFXp+N>=j=koFsB?|_+}e(R1_mR z1!3elpqzrVy@|M~9<_HidjK2vj)dR?p_uyp-ePej&brl0A9vz5`~hU{8z!z+1J(Nm zYu2a$w9YjY9_$+~wyIFLw{KFsTLlnXfoJ~>b^8X1vWf^V?Jp5GsDX0`Y*qsi@0E&M z)xc8-Y*z!XzBfYirV1d96QFKYGW2~vM|?*`fztOUh&$DQ>-`Z4dsG0o*0Io3S8lg0 zbin<+IhuVv$T_g>fEGp^7#aA0xF^Yz%UC>2I9MniRB^)P0~5rX397`MEpt(R30uCf3F7KMvgzKfj=D{ zCjLnc{5BG=3 zhl63}393tb#}M%+6(fAtQ6%=k#oX7c^+)xhpBkt>I!qI&0!a2ydD~IEyZ!KJx+b^> zDG#zwWWeP^A)=_FK;f}GF+vSkj_KkeRRD?2skc<(LJH3v8z{!8XmIOTZgji~Am%J; z^ZUm$#Y7bW9zR~7Nl^jBIR>t@CBhD5O;b_e%i|-(3^kB`Vwjkv2FxcWpwD)k$dArb z!6dSfl(X{%u=q5&HRt4LIL=d!lVjllPaVh9lruyPJvA0yITNakh9daxa18u>B2^r% zk_nqmjfT9l#Qn{w(c%O(so=whHIq~T=`WR+O%bAD^M|>bM|+S4!?KTtYK%S5iE`OA zTw8aq3xQ1^4$@5NK^`Ty&J<#x{bDZs<71Dd`Ed7Qp*UT|3I3;xqi3oBG9|ClQUjXP zgWz%}nZM$6u~@ERf%B(_z?^g34`&{NcX(>nnNjc;o_gcVXmP%p{T`AU&U;KK0R6eF zxH`KHH&M=p9JlnGnsxEn38GUCoJU}x8c6(jqPR#6)O>Mt-)Xb^p#)!>oKsq-jx=jU; zNyfRZ z7s@m{Q~((=TAsQY+a0@vxJyNX$1av?+EoDYj**v56XK|ki2GF}_~v4B6HlpVF#M7}mTm%ZsaDo@S`te&7gQuDyIi8VqymU{Fx>ql3r1fF7e7%^;KJn+ z@l!RRxiV7xLJiEgGF-f&1~wwcEj94_D<$F`HIVfQO)u6@^2Be{@avxxi+@%FfBK|E z{8kO!9FVgBLOWbp?z!?#xp#J{V7?B5lM|5O9>ey4Bjwpa3c zH)@=3vpU|lS(WyXv;1pJmRh&69iqJV&>~e~PKt@>)2EB395Os-rDuARLsUC_sk}G6pQX0KQfaOQ!)Kup^SjgW3>e=}vh@I8{;YrO!tNO6T&nX` zNx9 zqj!nkXFF+QcP>0HrZqx$40A3#&2}A3r4_%(&~@CEmiJ~rYxz-FTHTx0{kRsx&->E; z?tFOmkAAA6JBB%z_joQXR?*D=r=v>O-Z<&n6F8UHu8k2HO7ZRH4qq!4{nfzF*G9zj zRRNfE7141RmR>6mLsS%Kx;{!1rUHm{wA_;B7YBd6o)gor2Pw}|JI@AnH*&=&6$R$r zD2|F%0VHLxqa2Q38!Yx$;qdK^@nVu182RORF;xw$`f`LgKn+~}a-N|@&8ryE85AQrgJMKq;xM8!C`KQ_{aaD{Bft8)LHN}?Idl*! zn7$9KH%u{9;juhu?tG)kX}3J@mN+UImeXOq+)f8E5B3|wdX817u#JXy5exPm*N|1l zPYC^oa48=dK1XT@Ze{s*INL&xr0a%n5fAg=$_q0pc?(Ojee#ckSaKr?z!xmWhZwSo zH6~|GJ$^>1tfvcmPJ5Uc=MpU(KRQ_|OxAMbL5Uu!nHigi>R0Z-t8!kTnHgI=5MESr z2$<2WKqfDj%#7<13c`{mVv{%Ju@p4wNFE!A(VaY&$17*-BN%l8Y6z&X(cPRPus|@* zB(TTVFp^WIW7#M`(lPBs>LA_y!Vy&~@Vr+v&-4;`R=$j~_$x+Nu=n#C8p63l=T}tY z+R4Agc_FW(Ds5h_UcOT_c^MV2dy4mH1J0R@-}CINlG$1LWj#yIu9A-?-QhhF=uYKudQzorU8trkbM zxsr-fuHH$-oz-ToLksPn$24k9wN$zmKkn66_=puYJ3h3-8^lUtS4_0c9OTfsJ_WrZqc|p~9?P z$S?d9YtS}rt|M1xwbXk2gqEreLvK-4y7mWJRJpL)Qc+EgG}YBv8?^Yyj=YPXaU6PT zC!@#H6$76aj-c>Hr8ck@O-A0hs?9`g9dhNq>yIpI>hp6`XT1SP2S8{;`o7GZPt>YiU zo>fF4iHduArc3aG|as7cTrE;o#wXwnr00lZGMLP%1xH#s+5a z+!(`R8t?e&wt~Npv{c|@OJz1NEH&(s50|k4Ny@P5$-~i9C~>6)P_kaWuV?88%f_+4 zFTjbS*Yf%6{B5B?i@y0yiA*61C|NvD&w1@ z44VwwkQ4)3*Tg-|d0#i|LBPA$?D`7LiF*z2Au-A$2#LO{Wltp!7>=nlmE$Xg@^Uh8 z>0y?LmTkaj443pr!@sN4l;gXMIy+}2r~a8Q30^hj`0N<_J3azeWc_fMX}J)iKQqSA zjP13yyc{pNePWDp%-Fv>8CM3YBIL;JLP4^S$}^b$c3mjhO>C9=Y7o}UpmfG3%Zd!=N*oD z+os2R207&fONi}O%KL6XfaXtQQaCBb(|>C4Ta~%oOy@BR{~9bWJHgVG;@-|`H`n05 z1K>_aK74{D@h1hYMEUp$79;OD%7PRi5|*__Pvx>hJ+eJtqN(=53iKqc%bdp}8v(uI z5#sXnAp(6qs65H=9faI^lBIRCoS1MHre(&7n;8^)@bXDE@gn)YSx8RhJ$wP53;OX% zi_iLc+VJBdxKDnvS;$1*MaYZM`euPf?FY>QweK}0_m5_QHX89Q94u)Os6)(Y5z=`# zHC#2^!9Iy!ueQW!xwfwj|3W~c(&qV8gz8SU2(;Pwj~0P?M@*}bI+}Ow@yux8<3m+S z@f#-_y?ZJZ8E@aH0`^vchRwQGfwn;%t-Ly4w{rPmZ32ypf;O&nW}A>3!o@Mcm?p@t zwhFP{Ckp%I9c{ei6=cF9|7sJ8Fvdm4m%%&k&#?*rF(4Y*r=1TH+y&7()%yxbDE zKx6M6CHmCO&G^yHHKeZP4xF%-v(&8>3XpT#TCU;BTF&z0T0xIs);eK0M&;{-jBsxE zPJd&&Kl(NWH0!j=B(cxmcmN^!&PLvVH`Z}8{AI2&OBQHCn2fn#E?{VYu|m$5g*e}1 z5u6BRAzP8PKEU{40LprHBku)&MFN(NTQA_lAo=n2LW0u8`$M=JUn0q?)}xY6d6yDh z#z+~-CqRftyxS9M($DTx3kADelm=3eiex z8>V=N!>1P9#5lRNO^EGFZ(V2#M0x@iJ+MhgQ3_06%PmOWEF}3J#mJb$*E4e2W+6-A z`f{z1sH7IJ#X-<1@7>JhT)<-Sy~x#{<`R z5BTgF@9FDPtS0^X@om~kA9U4MF8qAb3~3Cws4v3h*B=f&wrD1UVg zO}ikUxGuzDRQ5M?-v#+T=KMMN_%$K+5lXqj@lb6wInCws7nuM{2RiIIAwDbY8WP`T^C}NT(M!6JO{PrPz4Ng3@>&! z-|%mS(>;t=o2=!wXgnIb{uxOzvfdR5Q$LA1==z(mF*uVe2r>*n1>sd@Cz)n0SDr=i zlbIpIFdm28)}MsvP|o|1!Gx;iu%ED#E1u|C?1H@cCvxAx_kR+m(>x*O`Oy?ukmpBj z_gJ1^d^{IrFg%NDgXw@!PB$GiUH%%W37oo=Z?{5~ClWsT?mR!*j9kWO5NEs0r+0t4 z<51ex@U^nj!K2+g8HQL;6}E2mJSC6O H`(^$QlYcG% delta 13685 zcmbVyd3aPs*0*&-_M4@%CnS)NJt3WiEeZP;2AUwKFf3}@Bn|0Hk`CPoiwY4P)IbA) z({Ldm35#qpECyvjS;7th4BI#kf}o=_@2I1E&->2eC$H~0b-Ozi^3L;o&-YJNo!|M@ zsZ*!w)~&jA?|dzP{kiP@T95UQvkrUb^eOSSRF|6baeWucg{vYpSetLVlmr-oBNVGIO=v>~#3et+d+hCfj1C zBg|Ae*J`uWR#d@n`y{}ZW1@APhFk_)S@L^Q{Z;9yr^b!^^v*x`SVyKRS30GG%anGH z*k92TcxN^}WeJK4IOlgCC$@MkP4EQW9i}i!MX+7a|S{!(#_lES0A&``= z_iyA~AkM?|5=hHRfoC#@!hdI`qlP*_n$?+^;LPX`Et!7sW=06rl^hdbN_sMQWj;-0 zuSVq(9M6nrXW-M!-oE4rRkUV3?Ka7hp)o5)HX1F}mRh4xU$fW=k25pir>uDYOB&sg zv35!ljL0^ytF4agB@DjLO@W-8S{R?33>%-0gwJv&LwbHPOw`xGLClL@h=hOXCxd@Z zGF0X+gKask!hw}S?Uws06 zRS*W@{eC@;0;ObnVM61pjHVKetulp5G_Hz~N)!^Mib^z|$}3c&u~ZtU)CPz9h4-iK zD6J&ZU@2`>qJdIAp%TSLxre1XM~_--ncca>nW0>5{b#>C2CqDu(mHWKIu&&A>2tkX zcMN=$3$1yDZ)k;cMMkaAfAB2^iMB!*G4vqu*9}_^-}LVbKhD>|`M07~Y2 z!=tiaL-4ENQnhAyo;R!=&?GgIVmkccxn9yLO|e2Vgf2;Mc|+TXsc?V%Na={iTRb6C zI;`;ybmP?<#!G+Dczq`3NOv^e%_n#(q@Oj;^RxWnTxqQIFOB#2F1(~6TJO+J>RpAV zq}~mEY2dmSieb~!z1aXrnv@SUlg{sNG?;*lrQd`vh63 z^#t|}j|&lXDeN_m3rl<`yllIm=Cg@4yD4l7mPSdNe0Yp+O`V8Ny1Nrmr-Mb)a@koA z`Lsy>&95i0zjh&~PuH_Qd&qwh$ zau)WC9dhw~A@gY~gy!KeZuJb~pIp_V)=f@f52>bf-xo*F3TMi4BriWmnozQCvJQS# zo+v%#M^7eu?6xfZJ_dHoxtB7@4=3VeN}i=; z8YMF*d7cs@B_`N8cV6~0RGdo5bV_DX@**bYI%O2~L7UMyj~xToPDz88D#C*Ktd7!V z^>9DWYJrZ>^Tb`A3bQPOrDYy}f3T!WOErIA(Q43)K&pG7F(efEyPinSp0`Chj$NzL zmX@PhHj#GiK7lb6U_WxL#U zq#gb^CHRtZU|}-5BrwAudr=%a?_r)HW|!sc4E%kOBd~MShijwm3&$5nXzN*lHu4Y9 z$S4U7(72uA0=7#+3kpNv;`4TV8ArgrR{~id$gdv<+g?b)x6qX3+DaN9@I=#4_hLBw z>D5$eTtL?+c3hWrv=A)}ftE==5?Y|okQ zu5qcu=+(p=ZZ&J*B^vBE1NaQ;ST-FWa`L=)VHmvrdVhS-UEZ_bb|tT1pL&S&^2z>9 zEW7O?-w?^}S%Kb=_j6G&o48DAGVqkn{V({kM5|n69V({S`5|n5+f*EZo@y$Ye zNo3NN1VP%57$m+KLFpp=-{lkPOYqS(aZ@iim6<*y(AEZpMqd)h&lTGKiuTHHD%TIG^DMN=0gIZnE>t>tf3GnNgv-cG8|4t(mV zB~C|Bg~@I-&#yDpTCCNs9US`gHt$CRAD*{)FB?Qm>$7N&>Rropf^f!N)4IJ}0+;fN-#O$#im!1-e{SCeMS z+BCniN^7-QqZJ{ApmK9fZ3RKdhvAI@2!Gp{1~rYrSgLOv$mMjn*BHc0{V`2kn}_L? zwK=?;7FcOsV6L>AYst!?wfzvSM+*V#Lb23y-B3(ttSfMFZRWWado7+Sk$YmD-o+gc z!QA_MTVr4_q#*hdkR2!V#k38wG5sEh9q*(bk8^5mr$Uo65anIY5=^&Y?Y*mmAZ&dU zO7)GYFloIGOE0ZYaffZi`ZNR%uOEcz<1Ko)zur$hy+QIrao>hqHSisYDqs;dZqQ02 zh`%NV?rw>KSd|*Xdb%=eWu>XcZZ?|B=i<2?&j)K0Mc&jaX)v;Nkupe5>6+Y#bDl)jQMGqaDNO5-)MLo1>ET+?% zD4x{V%x2!$w59?6cz~}ici#rRYSO(AcW0|$O+FVv^E+;><&L{CY!!Xrt*85dk%e7wH-WiV2`#ePjByROZdE3?j8@5S3 zTtiA_4IPZSds~NKy0tk^y}pSDduwyCpC^i2n@6JdK{Is~oq^z%z#crjWi2$q`&tSy zB@gTsrW)Skyp4Kw;&w?!{O%^buif%8hcS9twbq(S^CIpjE;$aLDsydxwcPop)8SiI zX|mhh8f6+h+!i0i53JL0*+N2$`tS=W91^zsvTKmKeHf-EcBH}M?SXDzufaRpi#%`` zmO^(FV`|tjkeAb7&yEPLFU0ikJJPz?kA_t{qcJ|$VD!#GoD~PxcLqYs&Tx;^3rpYc zO!U$Gg79}U5g7VzE~ZuQ=40CYZcn%J^t*k6_;K0ge-_+W77Kp6!r^Q~IOun!Livg? zFz?FXdGoGx#POxQE1S!ayZdo@=I$iUU%gx7pWm(Vf7zYSdB5yV0OOtrUS7UO)1BHA zP%pGxr%dDve}*y@b3CqNt;gMvjWSv8te#QT9OIawl9H&z^Q#bk$QJu zB9?#N7gOKev}ZkbdnCI&($;#nJ37%FkBYbNuT`Km-OUab*e;w?>jNql*O+Z{ZKj$E z4>^RByDB(4$X++QE6m*w3#~CWj}>%1*Vtbz5S_JzQOVD_b1kCEolqJ6D@UuoYbSd&Q$54_;bhI z5GMrMb7*6ffS{OZ+G$-vIS(t*IASdP9bJV0qQn-43 zq7)A`2YO(a!ww9?E>Ag-?8EEzhLD4iu;xH8f?E%yA>sUiEG++cAQsC32YW?wO9A$r za(rR)_Y0qdLl4Gi(c&5tuBm35r<>ZiQImtc|mKCRxw0r#7tQW*AJ!5T7|_7MZg_$ zDgP>-IG%q!uXQeSifUyOR(K2jnEjU1;bS+OY-PAjY9_l&m9EC%>BCVef@P&esM`4* z9iQNa!~O6KdE#*P^DB^|P*SlJ!>W?B(JfIUu9omsBv)9gt+qt_VtcKbHU_lrXjqO5 zLz3{o;wyX1`x*E;ta?8_eixad@m6+Y30vAn0RQaz9=!X0Y7wo^c=n)AxtNi0%;;2s z87-%nxz0Fb1tsl}qnrm_Yq-Dr=yDNyxAtULVQ}jU>?Uk#9V}1BRl8#8q*~mT--HLP zh4L&BNI5bv>O}!SryPCDthlZ~{*g?b=?T>Uczk4#TrQyS{gH9$bXojjI`mkv5IhrBY z3o2M~v{-&!1Uilm(k&MNGMfn_hbBSM?}~kHk~mI1HI~J|sAKu^3V{jNe>X;6B?7&U zO_du(p#Iq40BsyIDE8-$4Z$H{$I~NJfkjQE(BY-+RI=P8C}7_4e)2mauRPf`ee)1P0kbAms#FqlVyI5x_hesc!%3li#XgQq+@h7Ok&rfGX zd@HD^PCCto{4;6t-vk9rY|GO<5&&Wjhfkb6VNY9{{GWmb{@6AcW}GDRNoNMiKZ&Zc zGh-0mb0#<97Xc<)`PAyNvw5@5QG&yJA&MBoGhfg<34ZiE~x0#nZw z$vP2eIyX#?5P?4-5G?}w^S{!?2>>}bM1Ay}6akyhXUPeI3T~V))+Gu6aZA+0Gw{%m zdtrc_EU2L7!WcPC1WsQV7@H{oJQD7ACgfkuj_CV@wl5wENdZ02QiPXZER+ib3S7R} zUpGJi$l@@yWhhR~luKFgnAe(lX()_8NA-7H8V0L*>HAAVbt9jsmY7|-0O%{0MToHWH77w|XddtrW8t`f# zB2N|HSCPhNi`E2<$K?M^&83M!GU4a~~KAIs#!+}q-V%`);R6pNtqTI|4SiIXmp{EisG)f6JnXok zM>`+g$kA;Psu7`3UDhr|LCDP%xmi%b@S8=t?E*mDe(>$>bU1V~SbkT~z?GXt@*WWg zxiwgRPXwmj8YCYOflbIbECLU170E|LAocbbZ91mH=^Jry?RJoSOw@0`T_}Gn0^i&& zl23_1_MIa6j0n`+Db!5r)rZV09NO+A$QMPzU+?6}S41G~_XRQ61b~7N>iTg4M&1ao zca@!d1vGcvak+;ee3YfeWW$rDIdQbLy4*q^RGrG}WUEJ&$x`jqHd`dSk4#E2O3Gh? zpL(iOr=4GvXGBdeZIFG&Y6n>*OjP0?BJtCx`nawbN)B1$>s_A^v$``vTnx`)SBd)f zB+s!`N$XC64?c~o@6#Q3x8OM`E4{jt#NDyJyIMTKDh1v3?z1I~|3hHNu&#PMTgHSc zqn-e7?2n07CUgZ+!sk^um+73!?5-3%h$Yu6N>`BTbsnFTm%D4llbEvL-{{@n2yNZ< zKCa`HvJ`cJ!hFHQazdz5(zOPj5Tins>Le2|bg!TMjR?GSuQ2>S1c0pfvm4>W-G1_S0uFz@H(LHd1d8sDmj90kynVk|{x1=@ zet(Xh?!X%H2B&(_Y?IwmX4ltL&&30=o$h)jg`jS>!?(PWUspMm@i6;~d*kUi*&y8Q zH2nYG?ZDd)^!zGsiFP=}j1D!J(fbKAI-Fughf~bxaEcinPBEjaJk02riy3tTGrDEN z>|$%+!=DY(mu0Gd4$GUi9Q$FIY?zCOe81WAO0`c%3P%;g8+7zH+UyHWHBJqC)3A|a zWdgR@@E&6Rgcxnsh4{I8xwyOCaw~ph)@-^V3>ZfKe?fV0IroX6axB4Sh8jl#yQ;3tV+m;* zj}I_j{M1$9MW)t{IOynh9xIV@!&KcrrSW5v6Q8TF*b}usFB8k@ip*MLE>E0;-*P5T znlv%pp2$Ch&bC++Cyse$Ok$1As^FzdqP?!F%4|z4$jdJZP)A&3u}5?Jvwb>08U;hJ zAxC{UmZhd}DbG+za|SP1%kZyF{OVao-=VdcYBg+Cvr1T>Xe}U5a;~anB`nRGly&M4 zc`W(p;S%^UJQ; zDnG>%xeD_>m$h7d=``yT%qcrr=`o_jK*t(dPu@GtAI00JSvFg~p^dLG zJ==IV2DPz1$e7v2eR;Kw#iE3ibj(g_;Da`8WZPI4f*EI63TCBRW;??MqO|u6OT_HT z8E)mfGrWTTS-xUqoMrt{_rh70iP>9cdG-BgSwT4eWa*wp{BdkoADv~fJxHN$!)7Bn z#obf)EwwuQ9P6FeMdiM&rsv*0H|Eq;R(5Xx+SS$PSlsw7wRmJ*pHAHa*cok3jdV>k zeDvnxtuAeZE&P5^eRPf`M{$mOR%>TIw5MjBXYu@M+0j$YJCL7+?Hx~inE_-oL!{0^M}S5pY+wSW=ma-BeThzL&gRMzurY4tDXSqy7e z*#(x=OY9s~?CQ?Z5f@m=H5x9E5_UFDf?i7S?Ry z5j>*l9&D2Gkg03pEsSj9l!_)vkD%Hl4Z`e`CSKt`o1`3>d;flq(hqyQ>m>d7rq9A=+w!THdx{7;n@hxw5L69qeOGFD`9BUF|?+Pp%9R=L6m1 z@hzo#N5zogvrL_8S0^-c|L38kH4>}N?_jZbSKqGg*L2sKd8dBFESVdQ77Rb}`vg9q z>i6q;pC`3&%WGStICaT-`Xxfea+22L#`V}sGN$S_ND(yA{9MaLw8~T|%9s9vaH-=o z$D-FYyOz*Xo4Dmw+obr;prVwFO&s1PrE7*KHc36T(zly%`nRh|+xdtM*)GM$bPJGc zby90M>FCPs($c{=*a7z?db_6G=QE(>KA+u+Cat*7r`R4XyMSOGpH#hA=_q<0d(dYN z?LjXc!%FWXR)_y>xpCUjt54rYpRTESUr5oI9sUPK?wV>ssRvi*-j|}rQ^^r*sh(45 zsx=$uEi~EYVstnfR%u#nt*bRw(DLQ}IfrXPT^d@=jFpz^d06A<-7lo+(b~=`&@fP4 zi`F%%(D1x^{k{~PNgXh}Xn4J=`-a~b&OhP2=yD=&QRiy0cA*uw6|`;CoUC(%LH_jc zqd)&c+U%dk8}Kvqq4jF6xt3fr8@1bXZAnZqjK)VURPu@l|bVP0|3S|pyV zc1;bEyfA!6Qzfryv^Kn&=S8btOP&{v-N$)eF)`ef!SE6`>tANAsxi{3l(tXbp*D_d zm-78upmtRD=zHaR(Qal0X4#z9!PoR2I2`zbcXR4%1ztTPv|3%dd{I4E;Fb12#c1wa diff --git a/docs/build/_modules/algorithms/s_centrality_measures.html b/docs/build/_modules/algorithms/s_centrality_measures.html index 27c3ef2f..153730f6 100644 --- a/docs/build/_modules/algorithms/s_centrality_measures.html +++ b/docs/build/_modules/algorithms/s_centrality_measures.html @@ -161,7 +161,22 @@

Source code for algorithms.s_centrality_measures

 # Copyright © 2018 Battelle Memorial Institute
 # All rights reserved.
-# This module developed for PNNL's hyperbio LDRD project summer 2019
+
+"""
+
+S-Centrality Measures
+=====================
+We generalize graph metrics to s-metrics for a hypergraph by using its s-connected
+components. This is accomplished by computing the s edge-adjacency matrix and
+constructing the corresponding graph of the matrix. We then use existing graph metrics
+on this representation of the hypergraph. In essence we construct an *s*-line graph
+corresponding to the hypergraph on which to apply our methods.
+
+S-Metrics for hypergraphs are discussed in depth in:        
+*Aksoy, S.G., Joslyn, C., Ortiz Marrero, C. et al. Hypernetwork science via high-order hypergraph walks.
+EPJ Data Sci. 9, 16 (2020). https://doi.org/10.1140/epjds/s13688-020-00231-0*
+
+"""
 
 import numpy as np
 from collections import defaultdict
diff --git a/docs/build/algorithms/algorithms.html b/docs/build/algorithms/algorithms.html
index 51d97608..228bd9e3 100644
--- a/docs/build/algorithms/algorithms.html
+++ b/docs/build/algorithms/algorithms.html
@@ -101,7 +101,10 @@
 
  • Homology and Smith Normal Form
    • 
 
 
-
  • algorithms.s_centrality_measures module
    • 
+
  • algorithms.s_centrality_measures module
+
    • 
 
  • Module contents
    • 
 
 
@@ -599,6 +602,16 @@ 
    Homology Mod2
 
    algorithms.s_centrality_measures module
    
+
    
+
    S-Centrality Measures
    
+
    We generalize graph metrics to s-metrics for a hypergraph by using its s-connected
+components. This is accomplished by computing the s edge-adjacency matrix and
+constructing the corresponding graph of the matrix. We then use existing graph metrics
+on this representation of the hypergraph. In essence we construct an s-line graph
+corresponding to the hypergraph on which to apply our methods.
    
+
    S-Metrics for hypergraphs are discussed in depth in:
+Aksoy, S.G., Joslyn, C., Ortiz Marrero, C. et al. Hypernetwork science via high-order hypergraph walks.
+EPJ Data Sci. 9, 16 (2020). https://doi.org/10.1140/epjds/s13688-020-00231-0
    
 
    
 
    
 algorithms.s_centrality_measures.s_betweenness_centrality(H, s=1, normalized=True)[source]
    
@@ -672,6 +685,7 @@ 
    Homology Mod2
 
    Module contents
    
diff --git a/docs/build/algorithms/modules.html b/docs/build/algorithms/modules.html
index 52eb3a45..e96b072a 100644
--- a/docs/build/algorithms/modules.html
+++ b/docs/build/algorithms/modules.html
@@ -178,7 +178,10 @@ 
    algorithmsalgorithms.s_centrality_measures module
+
  • algorithms.s_centrality_measures module
+
    • 
 
  • Module contents
    • 
 
 
diff --git a/docs/build/searchindex.js b/docs/build/searchindex.js
index 976b5739..c4f8af3b 100644
--- a/docs/build/searchindex.js
+++ b/docs/build/searchindex.js
@@ -1 +1 @@
-Search.setIndex({docnames:["algorithms/algorithms","algorithms/modules","classes/classes","classes/modules","drawing/drawing","drawing/modules","glossary","index","install","license","overview/index","reports/modules","reports/reports"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["algorithms/algorithms.rst","algorithms/modules.rst","classes/classes.rst","classes/modules.rst","drawing/drawing.rst","drawing/modules.rst","glossary.rst","index.rst","install.rst","license.rst","overview/index.rst","reports/modules.rst","reports/reports.rst"],objects:{"":{algorithms:[0,0,0,"-"],classes:[2,0,0,"-"],drawing:[4,0,0,"-"],reports:[12,0,0,"-"]},"algorithms.homology_mod2":{add_to_column:[0,1,1,""],add_to_row:[0,1,1,""],bkMatrix:[0,1,1,""],coset:[0,1,1,""],homology_basis:[0,1,1,""],hypergraph_homology_basis:[0,1,1,""],interpret:[0,1,1,""],kchainbasis:[0,1,1,""],logical_dot:[0,1,1,""],logical_matadd:[0,1,1,""],logical_matmul:[0,1,1,""],matmulreduce:[0,1,1,""],reduced_row_echelon_form_mod2:[0,1,1,""],smith_normal_form_mod2:[0,1,1,""],swap_columns:[0,1,1,""],swap_rows:[0,1,1,""]},"algorithms.s_centrality_measures":{s_betweenness_centrality:[0,1,1,""],s_eccentricity:[0,1,1,""],s_harmonic_closeness_centrality:[0,1,1,""]},"classes.entity":{Entity:[2,2,1,""],EntitySet:[2,2,1,""]},"classes.entity.Entity":{add:[2,3,1,""],add_element:[2,3,1,""],add_elements_from:[2,3,1,""],children:[2,3,1,""],clone:[2,3,1,""],complete_registry:[2,3,1,""],depth:[2,3,1,""],elements:[2,3,1,""],fullregistry:[2,3,1,""],incidence_dict:[2,3,1,""],intersection:[2,3,1,""],is_bipartite:[2,3,1,""],is_empty:[2,3,1,""],level:[2,3,1,""],levelset:[2,3,1,""],memberships:[2,3,1,""],merge_entities:[2,3,1,""],nested_incidence_dict:[2,3,1,""],properties:[2,3,1,""],registry:[2,3,1,""],remove:[2,3,1,""],remove_element:[2,3,1,""],remove_elements_from:[2,3,1,""],restrict_to:[2,3,1,""],size:[2,3,1,""],uid:[2,3,1,""],uidset:[2,3,1,""]},"classes.entity.EntitySet":{add:[2,3,1,""],clone:[2,3,1,""],collapse_identical_elements:[2,3,1,""],incidence_matrix:[2,3,1,""],restrict_to:[2,3,1,""]},"classes.hypergraph":{Hypergraph:[2,2,1,""]},"classes.hypergraph.Hypergraph":{add_edge:[2,3,1,""],add_edges_from:[2,3,1,""],add_node_to_edge:[2,3,1,""],adjacency_matrix:[2,3,1,""],auxiliary_matrix:[2,3,1,""],bipartite:[2,3,1,""],collapse_edges:[2,3,1,""],collapse_nodes:[2,3,1,""],collapse_nodes_and_edges:[2,3,1,""],component_subgraphs:[2,3,1,""],components:[2,3,1,""],connected_component_subgraphs:[2,3,1,""],connected_components:[2,3,1,""],degree:[2,3,1,""],diameter:[2,3,1,""],dim:[2,3,1,""],distance:[2,3,1,""],dual:[2,3,1,""],edge_adjacency_matrix:[2,3,1,""],edge_diameter:[2,3,1,""],edge_diameters:[2,3,1,""],edge_distance:[2,3,1,""],edges:[2,3,1,""],from_bipartite:[2,3,1,""],from_dataframe:[2,3,1,""],from_numpy_array:[2,3,1,""],incidence_dict:[2,3,1,""],incidence_matrix:[2,3,1,""],is_connected:[2,3,1,""],neighbors:[2,3,1,""],node_diameters:[2,3,1,""],nodes:[2,3,1,""],number_of_edges:[2,3,1,""],number_of_nodes:[2,3,1,""],order:[2,3,1,""],remove_edge:[2,3,1,""],remove_edges:[2,3,1,""],remove_node:[2,3,1,""],remove_nodes:[2,3,1,""],remove_singletons:[2,3,1,""],restrict_to_edges:[2,3,1,""],restrict_to_nodes:[2,3,1,""],s_component_subgraphs:[2,3,1,""],s_components:[2,3,1,""],s_connected_components:[2,3,1,""],s_degree:[2,3,1,""],shape:[2,3,1,""],singletons:[2,3,1,""],size:[2,3,1,""],toplexes:[2,3,1,""]},"drawing.rubber_band":{draw:[4,1,1,""],draw_hyper_edge_labels:[4,1,1,""],draw_hyper_edges:[4,1,1,""],draw_hyper_labels:[4,1,1,""],draw_hyper_nodes:[4,1,1,""],get_default_radius:[4,1,1,""],inflate_kwargs:[4,1,1,""],layout_hyper_edges:[4,1,1,""],layout_node_link:[4,1,1,""]},"drawing.two_column":{draw:[4,1,1,""],draw_hyper_edges:[4,1,1,""],draw_hyper_labels:[4,1,1,""],layout_two_column:[4,1,1,""]},"drawing.util":{get_frozenset_label:[4,1,1,""],get_line_graph:[4,1,1,""],get_set_layering:[4,1,1,""]},"reports.descriptive_stats":{centrality_stats:[12,1,1,""],comp_dist:[12,1,1,""],degree_dist:[12,1,1,""],dist_stats:[12,1,1,""],edge_size_dist:[12,1,1,""],frequency_distribution:[12,1,1,""],info:[12,1,1,""],info_dict:[12,1,1,""],s_comp_dist:[12,1,1,""],s_edge_diameter_dist:[12,1,1,""],s_node_diameter_dist:[12,1,1,""],toplex_dist:[12,1,1,""]},algorithms:{homology_mod2:[0,0,0,"-"],s_centrality_measures:[0,0,0,"-"]},classes:{entity:[2,0,0,"-"],hypergraph:[2,0,0,"-"]},drawing:{rubber_band:[4,0,0,"-"],two_column:[4,0,0,"-"],util:[4,0,0,"-"]},reports:{descriptive_stats:[12,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"2x2":2,"76rl01830":10,"abstract":0,"boolean":[0,2],"case":2,"class":[6,7,10],"default":[0,2,4,12],"final":0,"float":[0,2,4],"function":[2,4],"import":2,"int":[0,2,4],"long":[2,12],"new":[0,2,4],"null":8,"return":[0,2,4,6,12],"static":2,"switch":6,"true":[0,2,4,12],AND:9,ARE:9,BUT:9,FOR:9,For:[0,2,4,6,7,8,10],NOT:9,Not:2,One:2,SUCH:9,Such:9,THE:9,The:[0,2,4,6,7,10],Then:4,These:0,USE:9,Use:6,Uses:2,Using:2,__dict__:2,abov:[4,9,12],abs:2,ac05:10,accept:[2,4],access:[6,8],account:10,accuraci:10,aco5:10,across:4,action:0,activ:[7,8,10],add:2,add_edg:2,add_edges_from:2,add_el:2,add_elements_from:2,add_node_to_edg:2,add_nodes_from:2,add_to_column:0,add_to_row:0,added:[0,2,4],adding:2,addit:[0,2],adjac:[2,6],adjacency_matrix:2,adjust:4,advis:9,after:2,against:2,agenc:10,aggreg:12,aksoi:10,algorithm:[4,7,10],align:4,all:[0,2,4,6,8,12],allow:[2,4],alpha:4,alreadi:2,also:[2,6,12],alter:0,amount:4,anaconda3:8,anaconda:7,analysi:10,analyt:10,angl:4,ani:[2,6,9,10],annot:4,anoth:[0,4,6],apparatu:10,appear:2,appli:[0,2,4],applic:2,approach:4,appropri:4,ar1:0,ar2:0,arbitrari:4,arendt:10,arg:[0,2],arg_set:2,argument:[2,4],argumetn:4,aris:9,around:4,arr:0,arrai:[0,2],asc:0,aspect:12,assign:[2,4],associ:[0,2,9],assum:[2,10],attribut:6,author:10,auxiliari:[2,6],auxiliary_matrix:2,axi:4,band:4,base:[0,2,4,6],basi:0,basic:[2,6,12],bat:8,battel:[9,10],becom:2,befor:2,behavior:0,behind:4,being:0,belong:[2,6],below:8,berg:0,best:0,betti:0,between:[0,2,4,6,7],binari:[0,9],bipartit:[2,4,6],bkmatrix:0,bool:[0,2,4],both:[2,6,7,10],bound:0,boundari:[0,4],box:4,brenda:10,briefest:0,browser:8,bsd:8,build:[2,8],build_doc:8,busi:9,c_k:0,calcul:4,call:[4,6],can:[2,4,6,7],cannot:2,cardin:2,care:2,caus:[2,9],cell:[0,2,12],center:4,central:[0,12],centrality_stat:12,certain:2,chain:0,chang:[4,7,10],check:2,child:2,children:[2,6],chmod:8,choos:2,chosen:4,circl:4,classmethod:2,claus:8,cliff:10,clone:[2,8],close:0,code:9,cokernel:0,coldict:2,collaps:[2,4],collapse_edg:2,collapse_identical_el:2,collapse_nod:2,collapse_nodes_and_edg:2,collect:4,collumn:4,color:4,column:[0,2,4,6,12],column_index:2,com:8,come:8,command:8,comment:[7,10],commerci:10,comp:12,comp_dist:12,complet:[6,10],complete_registri:2,complex:[0,2,7,10],compon:[2,4,6,12],component_subgraph:2,comput:[0,2,4,12],concentr:4,conda:8,condit:[2,6,9],conflict:2,connect:[0,2,4,6,12],connected_compon:2,connected_component_subgraph:2,consecut:2,consent:9,consequenti:9,consid:[0,2],constitut:10,construct:[2,6],constructor:[2,4],contact:[7,10],contain:[0,2,4,6,7,10,12],content:[1,3,5,11],continu:8,contract:[9,10],contributor:9,control:2,conveni:4,convert:[2,4],convex:4,cooper:10,coordin:4,copi:[0,2,9],copyright:9,correct:4,correspond:[0,2,6],coset:0,could:2,count:[2,4,12],creat:[2,8,12],cross:4,csr:2,csr_matrix:2,current:[7,10],curvi:4,custom:4,cycl:[0,2,4],cyclic:0,damag:9,data:[0,2,4,7,9,10],datafram:2,dedup:2,deeper:2,defin:2,degre:[2,6,12],degree_dist:12,delet:2,demand:[7,10],densiti:12,depart:10,depend:2,depth:[2,6],descend:2,descript:0,descriptive_stat:11,design:[7,10],desir:2,determin:[2,4],develop:[7,10],deviat:12,diagon:[0,2],diagram:4,diamet:[2,6,12],dict:[0,2,4,12],dictionari:[0,2,4,6,12],differ:2,digraph:4,dim:2,dimens:[0,2],dimension:0,direct:[2,4,9],directli:[7,10],dirti:4,disabl:4,discard:2,disclaim:9,disclos:10,disconnect:4,discov:0,disjoint:[2,6],disonnecct:4,dist:12,dist_stat:12,distanc:[2,4,6],distant:4,distinct:2,distinguish:[2,6],distribut:[9,12],dlfer:0,doc:8,document:[8,9],doe:[2,4,10],doing:2,done:2,dot:0,draw:7,draw_hyper_edg:4,draw_hyper_edge_label:4,draw_hyper_label:4,draw_hyper_nod:4,drawn:4,drop:2,dual:[2,6,7],duplic:[0,2],dustin:10,e_1:2,e_2:2,e_end:2,e_n:2,e_start:2,each:[0,2,4,6,7,12],easier:4,eccentr:0,eccentricity_dict:0,echelon:0,edg:[0,2,4,6,7,12],edge_adjac:2,edge_adjacency_matrix:2,edge_diamet:2,edge_dist:2,edge_kwarg:4,edge_label:2,edge_labels_kwarg:4,edge_nam:2,edge_set:2,edge_size_dist:12,edge_uid:2,edges_kwarg:4,edgeset:2,edgess:2,edit:8,effect:2,either:[6,7,12],element:[0,2,4,6,12],element_subset:2,els:0,emili:10,emploi:2,employe:10,empti:[2,6],end:2,endors:10,energi:10,ensur:2,ent1:2,ent2:2,entiti:[0,3,4,6,7,9],entityset:[2,6],entri:[0,6],env:8,environ:7,equal:[0,2,6,12],equat:0,equival:[0,2],error:[0,2],evalu:2,even:9,event:9,everi:[0,2,6],exactli:6,exampl:[0,2,4,8],exceed:2,except:6,exe:8,execut:8,exemplari:9,exhibit:0,exist:[2,4,6],expand:4,expect:[7,10],express:[9,10],extens:8,facecolor:4,fail:2,fals:[0,2,4,12],favor:10,featur:0,ferrario:0,figur:4,file:[8,9],fill:12,fillna:2,find:4,first:[2,4],firstlevel:2,fit:9,follow:[2,4,8,9],fork:8,form:[1,9],format:12,found:7,fraction:[0,4],frequenc:12,frequency_distribut:12,from:[0,2,4,6,8,12],from_bipartit:[2,6],from_datafram:2,from_numpy_arrai:2,frozen:2,frozenset:2,fruchterman_reingold_layout:4,full:2,fullregistri:2,further:4,gener:[0,2,4,6,7,8,10,12],get_default_radiu:4,get_frozenset_label:4,get_line_graph:4,get_set_lay:4,github:8,give:2,given:[0,2,4,6],glossari:7,going:12,good:[0,9],gotten:2,gov:[7,10],govern:10,grant:9,graph:[2,4,6,7,10],graphic:10,grate:[7,10],greater:[0,2],group:0,guarante:4,handl:4,harmon:0,has:[2,6,10],hashabl:2,have:[0,2,4,6],header:2,helper:4,henc:2,herebi:9,herein:[9,10],hereinaft:9,high:10,higher:0,hist:12,hnx:[0,2,8],holder:9,homolog:1,homology_basi:0,homology_mod2:1,honor:2,howev:9,hpda:10,html:8,http:[0,8],hull:4,hyper:[2,4,6,7],hyperedg:[2,6],hypergraph:[0,3,4,6,7,10,12],hypergraph_homology_basi:0,hypernet:10,hypernetx:[2,9,10],hypernetxerror:[0,2],i_m:0,i_n:0,ideal:0,ident:[0,2,4],identifi:[0,2],ids:[2,4],illustr:4,im2:0,imag:0,impli:[4,9,10],impos:6,incid:[2,6,12],incidence_dict:2,incidence_matrix:2,incident:9,includ:[2,9],inclus:0,inde:2,independ:4,index:[0,2,6,7,8],indic:2,indirect:9,induc:[2,6],inf:2,infin:2,infinit:6,inflate_kwarg:4,info:12,info_dict:12,inform:[10,12],infring:10,inner:0,inseper:2,instal:7,instanc:[2,6],instanti:[2,6],instead:[2,4],institut:[9,10],instruct:8,integ:[0,2,4,6,12],intend:4,intens:2,inter:2,interest:0,intermedi:0,interpret:0,interrupt:9,intersect:[0,2,4,6],intuit:6,invers:0,invert:0,investig:10,invis:4,is_bipartit:2,is_connect:2,is_empti:2,isn:2,isomorph:[2,6],item:[2,12],iter:[0,2,4,12],ith:0,iti:6,its:[0,2,4,6,10],itself:[2,6],joslyn:10,jth:0,jupyt:8,jurisdict:10,kbasi:0,kchain:0,kchainbasi:0,keep:[2,12],kei:[0,2,4,6,12],kernel:0,keyword:[2,4],km1basi:0,known:2,kth:0,kwarg:4,kyle:10,label:[2,4],label_alpha:4,laberl:4,laboratori:10,larg:2,last:2,lastlevel:2,lawfulli:9,layer:4,layout:4,layout_hyper_edg:4,layout_kwarg:4,layout_node_link:4,layout_two_column:4,least:[2,4,6],left:[0,4],legal:10,len:12,length:[0,2,4,6],less:[0,2],let:2,level:[2,4,6],levelset:[2,6],liabil:[9,10],liabl:9,librari:[7,10],licens:7,like:[2,4],limit:9,line:[2,4],linecollect:4,linewidth:4,link:2,linv:0,list:[0,2,4,9,12],llinv:0,lmr:0,locat:[4,8],log:0,logfil:0,logic:0,logical_dot:0,logical_matadd:0,logical_matmul:0,longest:2,look:0,loss:9,lower:4,mac:8,made:2,mai:[2,6,7,8,9,10],make:[2,4,10],manag:10,mani:[2,7,10,12],manual:4,manufactur:10,map:[0,4],mark:10,mat1:0,mat2:0,mat:0,match:[0,2],materi:10,mathemat:10,matmulreduc:0,matplotlib:[4,8],matric:[0,4],matrix:[0,2,6,12],max:[0,12],max_depth:2,maxim:[2,6],maximum:[2,6],mean:[0,2,12],measur:0,median:[4,12],membership:[2,4,6],memori:[9,10],merchant:9,merg:[2,9],merge_ent:2,method:[0,2,6,7,10,12],metric:[7,10],min:12,minim:[0,4,8],minimum:[0,4],minu:2,miss:4,mod2:1,mod:0,model:7,modif:9,modifi:9,modul:[1,3,5,7,11],modulo:0,monson:10,more:[2,6],most:4,multi:[2,7,10],multipl:[0,2,6],multipli:0,must:[0,2,9],mxn:0,name:[2,7,8,9,10],nation:10,ncell:12,ncol:12,ndarrai:[0,2],necessarili:10,need:[0,4,8],neglig:9,neighbor:2,neither:[9,10],nest:[2,7,10],nested_incidence_dict:2,network:[2,7,10],networkx:[2,4],netwrokx:4,newuid:2,node:[0,2,4,6,7,12],node_diamet:2,node_label:2,node_labels_kwarg:4,node_nam:2,node_radiu:4,node_set:2,nodes_kwarg:4,nodeset:2,non:6,none:[0,2,4,12],nonempti:[2,6],nonexist:2,nonzero:6,nor:10,normal:1,northwest:10,note:[0,2,6],notebook:8,noth:2,notic:[7,9],nrow:12,num:12,number:[0,2,4,6,12],number_of_edg:2,number_of_nod:2,numpi:[0,2,4],nx2:4,nxm:0,obj:12,object:[2,6,12],obtain:[0,6,9],occupi:6,occur:2,off:2,offset:4,onc:8,one:[0,2,4,6],onli:[0,2,6],open:8,oper:10,opinion:10,optim:4,option:[0,2,12],order:[0,2,4],organ:10,orient:4,origin:0,other:[0,2,4,6,7,9],otherwis:[2,6,8,9,10],out:[0,4,7,9,10],output:2,over:[0,4,6],overlap:4,overview:7,own:[6,10],pacif:10,packag:[1,3,5,7,11],page:7,pair:[2,4,6],pairwis:2,panda:2,paper:4,parallel:4,paramet:[0,2,4,12],part:[4,10],particular:[2,9],partit:[2,6],pass:[0,4],path:[0,2,4,8],perform:[2,10],permiss:9,permit:9,person:9,pickl:[0,2],pip:7,place:2,planar:4,plot:4,pnnl:[7,8,10],point:[0,4],poli:4,polycollect:4,polygon:4,pos:4,poset:2,posit:[2,4,6,12],possibl:[4,9],post:0,powershel:8,praggasti:10,pre:4,precis:6,prefer:2,preliminari:[7,10],prepar:10,prepend:2,present:2,preserv:2,principl:10,print:[0,12],prior:2,privat:10,process:[2,10],procur:9,product:[0,10],profit:9,program:10,project:[0,10],prompt:8,prop:2,properli:6,properti:[2,6],provid:[2,4,7,9,10],ps1:8,publish:9,purpos:[0,9],purvin:10,put:12,pytest:8,python:8,question:[7,10],quick:4,quit:2,radiu:4,rais:[0,2],rang:0,rather:12,ratio:12,rauga:10,read:4,real:2,reason:[2,4],recommend:[4,10],rectangular:[0,6],recurs:0,redistribut:9,reduc:[0,4],reduced_row_echelon_form_mod2:0,refer:[2,10],referenc:[0,2],reflect:[2,10],regist:2,registri:[2,6],relat:2,relationship:[0,2,7,10],releas:8,remov:2,remove_edg:2,remove_el:2,remove_elements_from:2,remove_nod:2,remove_singleton:2,render:4,rep:2,repeatedli:0,replac:[0,2],report:7,repres:[0,2,4,7,10],represent:4,reproduc:[4,9],requir:[7,10],reserv:4,respect:[0,2],respons:10,restrict:[2,6],restrict_to:2,restrict_to_edg:2,restrict_to_nod:2,result:4,retain:9,return_count:2,revers:[0,2],right:[0,4,10],rigor:4,ring:4,role:[2,6],root:2,row:[0,2,6,12],rowdict:2,rubber:4,rubber_band:5,run:8,s_betweenness_centr:0,s_centrality_measur:1,s_comp_dist:12,s_compon:2,s_component_subgraph:2,s_components_subgraph:2,s_connect:2,s_connected_compon:2,s_degre:2,s_distanc:0,s_eccentr:0,s_edge_connect:2,s_edge_diameter_dist:12,s_harmonic_closeness_centr:0,s_node_diameter_dist:12,same:[0,2,4,6],sampl:2,satifi:2,satisfi:[2,6],scipi:2,script:8,search:7,see:[2,4,6,8,12],self:2,sell:9,sens:6,sensibl:4,separ:2,sequenc:[2,6],serv:2,servic:[9,10],set:[0,2,4,6,7,10],set_nam:2,setsystem:2,shabang:8,shall:9,shallow:2,shape:2,share:[2,6],shortest:[0,2,6],shortest_path_length:2,should:[0,2,4],side:[0,2],similar:2,simpl:[0,2,6,12],simplici:0,sinan:10,sinc:[2,6],singl:[0,2,6,12],singleton:2,size:[0,2,4,6,12],small:[0,4],smaller:4,smallest:0,smith:1,smith_normal_form_mod2:0,snf:0,softwar:[9,10],some:6,sometim:4,sortabl:[0,2],sourc:[0,2,4,8,9,12],space:4,spars:2,special:9,specif:[2,6,10],specifi:[4,8],spectral:4,sponsor:10,spring_layout:4,squar:6,stack:4,standard:12,start:[0,2,4,12],stat:12,state:10,statist:12,store:0,str:[0,2],strict:9,string:[2,4,12],structur:[2,6,7,10],style:4,subgraph:[0,2],subhypergraph:6,subject:9,sublicens:9,submatrix:6,submodul:[1,3,5,11],subset:[2,4,6],substitut:9,success:6,suggest:[7,10],sum:0,summari:12,suppli:4,support:10,sure:2,surround:4,swap:0,swap_column:0,swap_row:0,system:[2,4,7,10],take:[2,4],target:2,techniqu:4,test:[7,8,10],text:4,textbook:4,than:[0,2,6,9,12],thei:[2,4],them:[6,7,8,12],theori:9,therefor:2,thereof:10,thi:[0,2,4,6,8,9,10,12],those:10,through:[0,4],thrown:2,time:2,togeth:[0,4],toplex:[0,2,6,12],toplex_dist:12,topolog:0,tort:9,track:[0,2,12],trade:10,trademark:10,tradit:[7,10],transform:[0,2],transpar:4,transpos:2,treat:2,truthi:2,tupl:[0,2],tutori:8,two:[0,2,4,6],two_column:5,type:[0,2,4,12],typic:4,uid:[0,2,6,12],uidset:[2,6],under:[8,10],undesir:2,uniqu:[2,6,12],unit:10,unpack:2,unweight:[2,6],updat:2,use:[2,4,8,9,10],use_rep:2,used:[0,2,4,6,9],usefulness:10,user:[2,8],uses:[2,7,10],using:[0,2,4,6,7],usual:4,util:5,v_1:2,v_2:2,v_end:2,v_n:2,v_start:2,valu:[0,2,4,6,12],variou:12,vector:0,veri:0,verifi:0,version:[7,8,10],vertex:4,vertic:[2,4],view:10,virtual:8,virtualenv:7,visual:10,wai:[2,4,7,9,10],walk:[2,6],want:0,warn:0,warranti:[9,10],weight:[2,6],well:4,whatsoev:9,when:2,where:[0,2,4,6],whether:9,which:[0,2,4,6,12],whitespac:4,whole:8,whose:[4,6],window:8,wish:8,with_color:4,with_edge_count:4,with_edge_label:4,with_node_count:4,with_node_label:4,within:[2,4,12],without:9,work:[0,4,7,10],would:[2,7,10],wrap:4,written:9,www:0,x_0:2,x_1:2,xor:0,xyz:0,yet:2,you:[4,7,8,10],your:8,z_2:0,zero:2},titles:["algorithms package","algorithms","classes package","classes","drawing package","drawing","Glossary of HNX terms","HyperNetX (HNX)","Installing HyperNetX","License","Overview","reports","reports package"],titleterms:{"class":[2,3],algorithm:[0,1],anaconda:8,content:[0,2,4,7,12],descript:7,descriptive_stat:12,draw:[4,5],entiti:2,environ:8,form:0,glossari:6,hnx:[6,7],homolog:0,homology_mod2:0,hypergraph:2,hypernetx:[7,8],indic:7,instal:8,licens:[8,9],mod2:0,modul:[0,2,4,12],normal:0,notic:10,overview:10,packag:[0,2,4,12],pip:8,report:[11,12],rubber_band:4,s_centrality_measur:0,smith:0,submodul:[0,2,4,12],tabl:7,term:6,two_column:4,using:8,util:4,virtualenv:8}})
\ No newline at end of file
+Search.setIndex({docnames:["algorithms/algorithms","algorithms/modules","classes/classes","classes/modules","drawing/drawing","drawing/modules","glossary","index","install","license","overview/index","reports/modules","reports/reports"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,"sphinx.ext.intersphinx":1,"sphinx.ext.todo":2,"sphinx.ext.viewcode":1,sphinx:56},filenames:["algorithms/algorithms.rst","algorithms/modules.rst","classes/classes.rst","classes/modules.rst","drawing/drawing.rst","drawing/modules.rst","glossary.rst","index.rst","install.rst","license.rst","overview/index.rst","reports/modules.rst","reports/reports.rst"],objects:{"":{algorithms:[0,0,0,"-"],classes:[2,0,0,"-"],drawing:[4,0,0,"-"],reports:[12,0,0,"-"]},"algorithms.homology_mod2":{add_to_column:[0,1,1,""],add_to_row:[0,1,1,""],bkMatrix:[0,1,1,""],coset:[0,1,1,""],homology_basis:[0,1,1,""],hypergraph_homology_basis:[0,1,1,""],interpret:[0,1,1,""],kchainbasis:[0,1,1,""],logical_dot:[0,1,1,""],logical_matadd:[0,1,1,""],logical_matmul:[0,1,1,""],matmulreduce:[0,1,1,""],reduced_row_echelon_form_mod2:[0,1,1,""],smith_normal_form_mod2:[0,1,1,""],swap_columns:[0,1,1,""],swap_rows:[0,1,1,""]},"algorithms.s_centrality_measures":{s_betweenness_centrality:[0,1,1,""],s_eccentricity:[0,1,1,""],s_harmonic_closeness_centrality:[0,1,1,""]},"classes.entity":{Entity:[2,2,1,""],EntitySet:[2,2,1,""]},"classes.entity.Entity":{add:[2,3,1,""],add_element:[2,3,1,""],add_elements_from:[2,3,1,""],children:[2,3,1,""],clone:[2,3,1,""],complete_registry:[2,3,1,""],depth:[2,3,1,""],elements:[2,3,1,""],fullregistry:[2,3,1,""],incidence_dict:[2,3,1,""],intersection:[2,3,1,""],is_bipartite:[2,3,1,""],is_empty:[2,3,1,""],level:[2,3,1,""],levelset:[2,3,1,""],memberships:[2,3,1,""],merge_entities:[2,3,1,""],nested_incidence_dict:[2,3,1,""],properties:[2,3,1,""],registry:[2,3,1,""],remove:[2,3,1,""],remove_element:[2,3,1,""],remove_elements_from:[2,3,1,""],restrict_to:[2,3,1,""],size:[2,3,1,""],uid:[2,3,1,""],uidset:[2,3,1,""]},"classes.entity.EntitySet":{add:[2,3,1,""],clone:[2,3,1,""],collapse_identical_elements:[2,3,1,""],incidence_matrix:[2,3,1,""],restrict_to:[2,3,1,""]},"classes.hypergraph":{Hypergraph:[2,2,1,""]},"classes.hypergraph.Hypergraph":{add_edge:[2,3,1,""],add_edges_from:[2,3,1,""],add_node_to_edge:[2,3,1,""],adjacency_matrix:[2,3,1,""],auxiliary_matrix:[2,3,1,""],bipartite:[2,3,1,""],collapse_edges:[2,3,1,""],collapse_nodes:[2,3,1,""],collapse_nodes_and_edges:[2,3,1,""],component_subgraphs:[2,3,1,""],components:[2,3,1,""],connected_component_subgraphs:[2,3,1,""],connected_components:[2,3,1,""],degree:[2,3,1,""],diameter:[2,3,1,""],dim:[2,3,1,""],distance:[2,3,1,""],dual:[2,3,1,""],edge_adjacency_matrix:[2,3,1,""],edge_diameter:[2,3,1,""],edge_diameters:[2,3,1,""],edge_distance:[2,3,1,""],edges:[2,3,1,""],from_bipartite:[2,3,1,""],from_dataframe:[2,3,1,""],from_numpy_array:[2,3,1,""],incidence_dict:[2,3,1,""],incidence_matrix:[2,3,1,""],is_connected:[2,3,1,""],neighbors:[2,3,1,""],node_diameters:[2,3,1,""],nodes:[2,3,1,""],number_of_edges:[2,3,1,""],number_of_nodes:[2,3,1,""],order:[2,3,1,""],remove_edge:[2,3,1,""],remove_edges:[2,3,1,""],remove_node:[2,3,1,""],remove_nodes:[2,3,1,""],remove_singletons:[2,3,1,""],restrict_to_edges:[2,3,1,""],restrict_to_nodes:[2,3,1,""],s_component_subgraphs:[2,3,1,""],s_components:[2,3,1,""],s_connected_components:[2,3,1,""],s_degree:[2,3,1,""],shape:[2,3,1,""],singletons:[2,3,1,""],size:[2,3,1,""],toplexes:[2,3,1,""]},"drawing.rubber_band":{draw:[4,1,1,""],draw_hyper_edge_labels:[4,1,1,""],draw_hyper_edges:[4,1,1,""],draw_hyper_labels:[4,1,1,""],draw_hyper_nodes:[4,1,1,""],get_default_radius:[4,1,1,""],inflate_kwargs:[4,1,1,""],layout_hyper_edges:[4,1,1,""],layout_node_link:[4,1,1,""]},"drawing.two_column":{draw:[4,1,1,""],draw_hyper_edges:[4,1,1,""],draw_hyper_labels:[4,1,1,""],layout_two_column:[4,1,1,""]},"drawing.util":{get_frozenset_label:[4,1,1,""],get_line_graph:[4,1,1,""],get_set_layering:[4,1,1,""]},"reports.descriptive_stats":{centrality_stats:[12,1,1,""],comp_dist:[12,1,1,""],degree_dist:[12,1,1,""],dist_stats:[12,1,1,""],edge_size_dist:[12,1,1,""],frequency_distribution:[12,1,1,""],info:[12,1,1,""],info_dict:[12,1,1,""],s_comp_dist:[12,1,1,""],s_edge_diameter_dist:[12,1,1,""],s_node_diameter_dist:[12,1,1,""],toplex_dist:[12,1,1,""]},algorithms:{homology_mod2:[0,0,0,"-"],s_centrality_measures:[0,0,0,"-"]},classes:{entity:[2,0,0,"-"],hypergraph:[2,0,0,"-"]},drawing:{rubber_band:[4,0,0,"-"],two_column:[4,0,0,"-"],util:[4,0,0,"-"]},reports:{descriptive_stats:[12,0,0,"-"]}},objnames:{"0":["py","module","Python module"],"1":["py","function","Python function"],"2":["py","class","Python class"],"3":["py","method","Python method"]},objtypes:{"0":"py:module","1":"py:function","2":"py:class","3":"py:method"},terms:{"2x2":2,"76rl01830":10,"abstract":0,"boolean":[0,2],"case":2,"class":[6,7,10],"default":[0,2,4,12],"final":0,"float":[0,2,4],"function":[2,4],"import":2,"int":[0,2,4],"long":[2,12],"new":[0,2,4],"null":8,"return":[0,2,4,6,12],"static":2,"switch":6,"true":[0,2,4,12],AND:9,ARE:9,BUT:9,FOR:9,For:[0,2,4,6,7,8,10],NOT:9,Not:2,One:2,SUCH:9,Such:9,THE:9,The:[0,2,4,6,7,10],Then:4,These:0,USE:9,Use:6,Uses:2,Using:2,__dict__:2,abov:[4,9,12],abs:2,ac05:10,accept:[2,4],access:[6,8],accomplish:0,account:10,accuraci:10,aco5:10,across:4,action:0,activ:[7,8,10],add:2,add_edg:2,add_edges_from:2,add_el:2,add_elements_from:2,add_node_to_edg:2,add_nodes_from:2,add_to_column:0,add_to_row:0,added:[0,2,4],adding:2,addit:[0,2],adjac:[0,2,6],adjacency_matrix:2,adjust:4,advis:9,after:2,against:2,agenc:10,aggreg:12,aksoi:[0,10],algorithm:[4,7,10],align:4,all:[0,2,4,6,8,12],allow:[2,4],alpha:4,alreadi:2,also:[2,6,12],alter:0,amount:4,anaconda3:8,anaconda:7,analysi:10,analyt:10,angl:4,ani:[2,6,9,10],annot:4,anoth:[0,4,6],apparatu:10,appear:2,appli:[0,2,4],applic:2,approach:4,appropri:4,ar1:0,ar2:0,arbitrari:4,arendt:10,arg:[0,2],arg_set:2,argument:[2,4],argumetn:4,aris:9,around:4,arr:0,arrai:[0,2],asc:0,aspect:12,assign:[2,4],associ:[0,2,9],assum:[2,10],attribut:6,author:10,auxiliari:[2,6],auxiliary_matrix:2,axi:4,band:4,base:[0,2,4,6],basi:0,basic:[2,6,12],bat:8,battel:[9,10],becom:2,befor:2,behavior:0,behind:4,being:0,belong:[2,6],below:8,berg:0,best:0,betti:0,between:[0,2,4,6,7],binari:[0,9],bipartit:[2,4,6],bkmatrix:0,bool:[0,2,4],both:[2,6,7,10],bound:0,boundari:[0,4],box:4,brenda:10,briefest:0,browser:8,bsd:8,build:[2,8],build_doc:8,busi:9,c_k:0,calcul:4,call:[4,6],can:[2,4,6,7],cannot:2,cardin:2,care:2,caus:[2,9],cell:[0,2,12],center:4,central:[1,12],centrality_stat:12,certain:2,chain:0,chang:[4,7,10],check:2,child:2,children:[2,6],chmod:8,choos:2,chosen:4,circl:4,classmethod:2,claus:8,cliff:10,clone:[2,8],close:0,code:9,cokernel:0,coldict:2,collaps:[2,4],collapse_edg:2,collapse_identical_el:2,collapse_nod:2,collapse_nodes_and_edg:2,collect:4,collumn:4,color:4,column:[0,2,4,6,12],column_index:2,com:8,come:8,command:8,comment:[7,10],commerci:10,comp:12,comp_dist:12,complet:[6,10],complete_registri:2,complex:[0,2,7,10],compon:[0,2,4,6,12],component_subgraph:2,comput:[0,2,4,12],concentr:4,conda:8,condit:[2,6,9],conflict:2,connect:[0,2,4,6,12],connected_compon:2,connected_component_subgraph:2,consecut:2,consent:9,consequenti:9,consid:[0,2],constitut:10,construct:[0,2,6],constructor:[2,4],contact:[7,10],contain:[0,2,4,6,7,10,12],content:[1,3,5,11],continu:8,contract:[9,10],contributor:9,control:2,conveni:4,convert:[2,4],convex:4,cooper:10,coordin:4,copi:[0,2,9],copyright:9,correct:4,correspond:[0,2,6],coset:0,could:2,count:[2,4,12],creat:[2,8,12],cross:4,csr:2,csr_matrix:2,current:[7,10],curvi:4,custom:4,cycl:[0,2,4],cyclic:0,damag:9,data:[0,2,4,7,9,10],datafram:2,dedup:2,deeper:2,defin:2,degre:[2,6,12],degree_dist:12,delet:2,demand:[7,10],densiti:12,depart:10,depend:2,depth:[0,2,6],descend:2,descript:0,descriptive_stat:11,design:[7,10],desir:2,determin:[2,4],develop:[7,10],deviat:12,diagon:[0,2],diagram:4,diamet:[2,6,12],dict:[0,2,4,12],dictionari:[0,2,4,6,12],differ:2,digraph:4,dim:2,dimens:[0,2],dimension:0,direct:[2,4,9],directli:[7,10],dirti:4,disabl:4,discard:2,disclaim:9,disclos:10,disconnect:4,discov:0,discuss:0,disjoint:[2,6],disonnecct:4,dist:12,dist_stat:12,distanc:[2,4,6],distant:4,distinct:2,distinguish:[2,6],distribut:[9,12],dlfer:0,doc:8,document:[8,9],doe:[2,4,10],doi:0,doing:2,done:2,dot:0,draw:7,draw_hyper_edg:4,draw_hyper_edge_label:4,draw_hyper_label:4,draw_hyper_nod:4,drawn:4,drop:2,dual:[2,6,7],duplic:[0,2],dustin:10,e_1:2,e_2:2,e_end:2,e_n:2,e_start:2,each:[0,2,4,6,7,12],easier:4,eccentr:0,eccentricity_dict:0,echelon:0,edg:[0,2,4,6,7,12],edge_adjac:2,edge_adjacency_matrix:2,edge_diamet:2,edge_dist:2,edge_kwarg:4,edge_label:2,edge_labels_kwarg:4,edge_nam:2,edge_set:2,edge_size_dist:12,edge_uid:2,edges_kwarg:4,edgeset:2,edgess:2,edit:8,effect:2,either:[6,7,12],element:[0,2,4,6,12],element_subset:2,els:0,emili:10,emploi:2,employe:10,empti:[2,6],end:2,endors:10,energi:10,ensur:2,ent1:2,ent2:2,entiti:[0,3,4,6,7,9],entityset:[2,6],entri:[0,6],env:8,environ:7,epj:0,epjd:0,equal:[0,2,6,12],equat:0,equival:[0,2],error:[0,2],essenc:0,evalu:2,even:9,event:9,everi:[0,2,6],exactli:6,exampl:[0,2,4,8],exceed:2,except:6,exe:8,execut:8,exemplari:9,exhibit:0,exist:[0,2,4,6],expand:4,expect:[7,10],express:[9,10],extens:8,facecolor:4,fail:2,fals:[0,2,4,12],favor:10,featur:0,ferrario:0,figur:4,file:[8,9],fill:12,fillna:2,find:4,first:[2,4],firstlevel:2,fit:9,follow:[2,4,8,9],fork:8,form:[1,9],format:12,found:7,fraction:[0,4],frequenc:12,frequency_distribut:12,from:[0,2,4,6,8,12],from_bipartit:[2,6],from_datafram:2,from_numpy_arrai:2,frozen:2,frozenset:2,fruchterman_reingold_layout:4,full:2,fullregistri:2,further:4,gener:[0,2,4,6,7,8,10,12],get_default_radiu:4,get_frozenset_label:4,get_line_graph:4,get_set_lay:4,github:8,give:2,given:[0,2,4,6],glossari:7,going:12,good:[0,9],gotten:2,gov:[7,10],govern:10,grant:9,graph:[0,2,4,6,7,10],graphic:10,grate:[7,10],greater:[0,2],group:0,guarante:4,handl:4,harmon:0,has:[2,6,10],hashabl:2,have:[0,2,4,6],header:2,helper:4,henc:2,herebi:9,herein:[9,10],hereinaft:9,high:[0,10],higher:0,hist:12,hnx:[0,2,8],holder:9,homolog:1,homology_basi:0,homology_mod2:1,honor:2,howev:9,hpda:10,html:8,http:[0,8],hull:4,hyper:[2,4,6,7],hyperedg:[2,6],hypergraph:[0,3,4,6,7,10,12],hypergraph_homology_basi:0,hypernet:10,hypernetwork:0,hypernetx:[2,9,10],hypernetxerror:[0,2],i_m:0,i_n:0,ideal:0,ident:[0,2,4],identifi:[0,2],ids:[2,4],illustr:4,im2:0,imag:0,impli:[4,9,10],impos:6,incid:[2,6,12],incidence_dict:2,incidence_matrix:2,incident:9,includ:[2,9],inclus:0,inde:2,independ:4,index:[0,2,6,7,8],indic:2,indirect:9,induc:[2,6],inf:2,infin:2,infinit:6,inflate_kwarg:4,info:12,info_dict:12,inform:[10,12],infring:10,inner:0,inseper:2,instal:7,instanc:[2,6],instanti:[2,6],instead:[2,4],institut:[9,10],instruct:8,integ:[0,2,4,6,12],intend:4,intens:2,inter:2,interest:0,intermedi:0,interpret:0,interrupt:9,intersect:[0,2,4,6],intuit:6,invers:0,invert:0,investig:10,invis:4,is_bipartit:2,is_connect:2,is_empti:2,isn:2,isomorph:[2,6],item:[2,12],iter:[0,2,4,12],ith:0,iti:6,its:[0,2,4,6,10],itself:[2,6],joslyn:[0,10],jth:0,jupyt:8,jurisdict:10,kbasi:0,kchain:0,kchainbasi:0,keep:[2,12],kei:[0,2,4,6,12],kernel:0,keyword:[2,4],km1basi:0,known:2,kth:0,kwarg:4,kyle:10,label:[2,4],label_alpha:4,laberl:4,laboratori:10,larg:2,last:2,lastlevel:2,lawfulli:9,layer:4,layout:4,layout_hyper_edg:4,layout_kwarg:4,layout_node_link:4,layout_two_column:4,least:[2,4,6],left:[0,4],legal:10,len:12,length:[0,2,4,6],less:[0,2],let:2,level:[2,4,6],levelset:[2,6],liabil:[9,10],liabl:9,librari:[7,10],licens:7,like:[2,4],limit:9,line:[0,2,4],linecollect:4,linewidth:4,link:2,linv:0,list:[0,2,4,9,12],llinv:0,lmr:0,locat:[4,8],log:0,logfil:0,logic:0,logical_dot:0,logical_matadd:0,logical_matmul:0,longest:2,look:0,loss:9,lower:4,mac:8,made:2,mai:[2,6,7,8,9,10],make:[2,4,10],manag:10,mani:[2,7,10,12],manual:4,manufactur:10,map:[0,4],mark:10,marrero:0,mat1:0,mat2:0,mat:0,match:[0,2],materi:10,mathemat:10,matmulreduc:0,matplotlib:[4,8],matric:[0,4],matrix:[0,2,6,12],max:[0,12],max_depth:2,maxim:[2,6],maximum:[2,6],mean:[0,2,12],measur:1,median:[4,12],membership:[2,4,6],memori:[9,10],merchant:9,merg:[2,9],merge_ent:2,method:[0,2,6,7,10,12],metric:[0,7,10],min:12,minim:[0,4,8],minimum:[0,4],minu:2,miss:4,mod2:1,mod:0,model:7,modif:9,modifi:9,modul:[1,3,5,7,11],modulo:0,monson:10,more:[2,6],most:4,multi:[2,7,10],multipl:[0,2,6],multipli:0,must:[0,2,9],mxn:0,name:[2,7,8,9,10],nation:10,ncell:12,ncol:12,ndarrai:[0,2],necessarili:10,need:[0,4,8],neglig:9,neighbor:2,neither:[9,10],nest:[2,7,10],nested_incidence_dict:2,network:[2,7,10],networkx:[2,4],netwrokx:4,newuid:2,node:[0,2,4,6,7,12],node_diamet:2,node_label:2,node_labels_kwarg:4,node_nam:2,node_radiu:4,node_set:2,nodes_kwarg:4,nodeset:2,non:6,none:[0,2,4,12],nonempti:[2,6],nonexist:2,nonzero:6,nor:10,normal:1,northwest:10,note:[0,2,6],notebook:8,noth:2,notic:[7,9],nrow:12,num:12,number:[0,2,4,6,12],number_of_edg:2,number_of_nod:2,numpi:[0,2,4],nx2:4,nxm:0,obj:12,object:[2,6,12],obtain:[0,6,9],occupi:6,occur:2,off:2,offset:4,onc:8,one:[0,2,4,6],onli:[0,2,6],open:8,oper:10,opinion:10,optim:4,option:[0,2,12],order:[0,2,4],org:0,organ:10,orient:4,origin:0,ortiz:0,other:[0,2,4,6,7,9],otherwis:[2,6,8,9,10],our:0,out:[0,4,7,9,10],output:2,over:[0,4,6],overlap:4,overview:7,own:[6,10],pacif:10,packag:[1,3,5,7,11],page:7,pair:[2,4,6],pairwis:2,panda:2,paper:4,parallel:4,paramet:[0,2,4,12],part:[4,10],particular:[2,9],partit:[2,6],pass:[0,4],path:[0,2,4,8],perform:[2,10],permiss:9,permit:9,person:9,pickl:[0,2],pip:7,place:2,planar:4,plot:4,pnnl:[7,8,10],point:[0,4],poli:4,polycollect:4,polygon:4,pos:4,poset:2,posit:[2,4,6,12],possibl:[4,9],post:0,powershel:8,praggasti:10,pre:4,precis:6,prefer:2,preliminari:[7,10],prepar:10,prepend:2,present:2,preserv:2,principl:10,print:[0,12],prior:2,privat:10,process:[2,10],procur:9,product:[0,10],profit:9,program:10,project:[0,10],prompt:8,prop:2,properli:6,properti:[2,6],provid:[2,4,7,9,10],ps1:8,publish:9,purpos:[0,9],purvin:10,put:12,pytest:8,python:8,question:[7,10],quick:4,quit:2,radiu:4,rais:[0,2],rang:0,rather:12,ratio:12,rauga:10,read:4,real:2,reason:[2,4],recommend:[4,10],rectangular:[0,6],recurs:0,redistribut:9,reduc:[0,4],reduced_row_echelon_form_mod2:0,refer:[2,10],referenc:[0,2],reflect:[2,10],regist:2,registri:[2,6],relat:2,relationship:[0,2,7,10],releas:8,remov:2,remove_edg:2,remove_el:2,remove_elements_from:2,remove_nod:2,remove_singleton:2,render:4,rep:2,repeatedli:0,replac:[0,2],report:7,repres:[0,2,4,7,10],represent:[0,4],reproduc:[4,9],requir:[7,10],reserv:4,respect:[0,2],respons:10,restrict:[2,6],restrict_to:2,restrict_to_edg:2,restrict_to_nod:2,result:4,retain:9,return_count:2,revers:[0,2],right:[0,4,10],rigor:4,ring:4,role:[2,6],root:2,row:[0,2,6,12],rowdict:2,rubber:4,rubber_band:5,run:8,s13688:0,s_betweenness_centr:0,s_centrality_measur:1,s_comp_dist:12,s_compon:2,s_component_subgraph:2,s_components_subgraph:2,s_connect:2,s_connected_compon:2,s_degre:2,s_distanc:0,s_eccentr:0,s_edge_connect:2,s_edge_diameter_dist:12,s_harmonic_closeness_centr:0,s_node_diameter_dist:12,same:[0,2,4,6],sampl:2,satifi:2,satisfi:[2,6],sci:0,scienc:0,scipi:2,script:8,search:7,see:[2,4,6,8,12],self:2,sell:9,sens:6,sensibl:4,separ:2,sequenc:[2,6],serv:2,servic:[9,10],set:[0,2,4,6,7,10],set_nam:2,setsystem:2,shabang:8,shall:9,shallow:2,shape:2,share:[2,6],shortest:[0,2,6],shortest_path_length:2,should:[0,2,4],side:[0,2],similar:2,simpl:[0,2,6,12],simplici:0,sinan:10,sinc:[2,6],singl:[0,2,6,12],singleton:2,size:[0,2,4,6,12],small:[0,4],smaller:4,smallest:0,smith:1,smith_normal_form_mod2:0,snf:0,softwar:[9,10],some:6,sometim:4,sortabl:[0,2],sourc:[0,2,4,8,9,12],space:4,spars:2,special:9,specif:[2,6,10],specifi:[4,8],spectral:4,sponsor:10,spring_layout:4,squar:6,stack:4,standard:12,start:[0,2,4,12],stat:12,state:10,statist:12,store:0,str:[0,2],strict:9,string:[2,4,12],structur:[2,6,7,10],style:4,subgraph:[0,2],subhypergraph:6,subject:9,sublicens:9,submatrix:6,submodul:[1,3,5,11],subset:[2,4,6],substitut:9,success:6,suggest:[7,10],sum:0,summari:12,suppli:4,support:10,sure:2,surround:4,swap:0,swap_column:0,swap_row:0,system:[2,4,7,10],take:[2,4],target:2,techniqu:4,test:[7,8,10],text:4,textbook:4,than:[0,2,6,9,12],thei:[2,4],them:[6,7,8,12],theori:9,therefor:2,thereof:10,thi:[0,2,4,6,8,9,10,12],those:10,through:[0,4],thrown:2,time:2,togeth:[0,4],toplex:[0,2,6,12],toplex_dist:12,topolog:0,tort:9,track:[0,2,12],trade:10,trademark:10,tradit:[7,10],transform:[0,2],transpar:4,transpos:2,treat:2,truthi:2,tupl:[0,2],tutori:8,two:[0,2,4,6],two_column:5,type:[0,2,4,12],typic:4,uid:[0,2,6,12],uidset:[2,6],under:[8,10],undesir:2,uniqu:[2,6,12],unit:10,unpack:2,unweight:[2,6],updat:2,use:[0,2,4,8,9,10],use_rep:2,used:[0,2,4,6,9],usefulness:10,user:[2,8],uses:[2,7,10],using:[0,2,4,6,7],usual:4,util:5,v_1:2,v_2:2,v_end:2,v_n:2,v_start:2,valu:[0,2,4,6,12],variou:12,vector:0,veri:0,verifi:0,version:[7,8,10],vertex:4,vertic:[2,4],via:0,view:10,virtual:8,virtualenv:7,visual:10,wai:[2,4,7,9,10],walk:[0,2,6],want:0,warn:0,warranti:[9,10],weight:[2,6],well:4,whatsoev:9,when:2,where:[0,2,4,6],whether:9,which:[0,2,4,6,12],whitespac:4,whole:8,whose:[4,6],window:8,wish:8,with_color:4,with_edge_count:4,with_edge_label:4,with_node_count:4,with_node_label:4,within:[2,4,12],without:9,work:[0,4,7,10],would:[2,7,10],wrap:4,written:9,www:0,x_0:2,x_1:2,xor:0,xyz:0,yet:2,you:[4,7,8,10],your:8,z_2:0,zero:2},titles:["algorithms package","algorithms","classes package","classes","drawing package","drawing","Glossary of HNX terms","HyperNetX (HNX)","Installing HyperNetX","License","Overview","reports","reports package"],titleterms:{"class":[2,3],algorithm:[0,1],anaconda:8,central:0,content:[0,2,4,7,12],descript:7,descriptive_stat:12,draw:[4,5],entiti:2,environ:8,form:0,glossari:6,hnx:[6,7],homolog:0,homology_mod2:0,hypergraph:2,hypernetx:[7,8],indic:7,instal:8,licens:[8,9],measur:0,mod2:0,modul:[0,2,4,12],normal:0,notic:10,overview:10,packag:[0,2,4,12],pip:8,report:[11,12],rubber_band:4,s_centrality_measur:0,smith:0,submodul:[0,2,4,12],tabl:7,term:6,two_column:4,using:8,util:4,virtualenv:8}})
\ No newline at end of file
diff --git a/hypernetx/algorithms/s_centrality_measures.py b/hypernetx/algorithms/s_centrality_measures.py
index 84f7d0b2..a4c61792 100644
--- a/hypernetx/algorithms/s_centrality_measures.py
+++ b/hypernetx/algorithms/s_centrality_measures.py
@@ -1,6 +1,21 @@
 # Copyright © 2018 Battelle Memorial Institute
 # All rights reserved.
-# This module developed for PNNL's hyperbio LDRD project summer 2019
+
+"""
+
+S-Centrality Measures
+=====================
+We generalize graph metrics to s-metrics for a hypergraph by using its s-connected
+components. This is accomplished by computing the s edge-adjacency matrix and
+constructing the corresponding graph of the matrix. We then use existing graph metrics
+on this representation of the hypergraph. In essence we construct an *s*-line graph
+corresponding to the hypergraph on which to apply our methods.
+
+S-Metrics for hypergraphs are discussed in depth in:        
+*Aksoy, S.G., Joslyn, C., Ortiz Marrero, C. et al. Hypernetwork science via high-order hypergraph walks.
+EPJ Data Sci. 9, 16 (2020). https://doi.org/10.1140/epjds/s13688-020-00231-0*
+
+"""
 
 import numpy as np
 from collections import defaultdict