xgi 1.0.0

CompleX Group Interactions (XGI) is a Python package for modeling, analyzing, and visualizing higher-order networks: hypergraphs, directed hypergraphs, and simplicial complexes. It covers the whole workflow, from start to finish, with data structures, generative models, measures, datasets, and drawing tools.

Documentation · Tutorials · Gallery · Datasets · Projects using XGI · Contribute

Install

pip install xgi

For other options (development version, optional dependencies), see the installation guide.

Getting started

To get started, take a look at the tutorials illustrating the library's basic functionality.

An example:

import xgi

# build
hyperedges = [[1, 2, 3], [3, 4, 5], [3, 6], [6, 7, 8, 9], [1, 4, 10, 11, 12], [1, 4]]
H = xgi.Hypergraph(hyperedges)

# analyze
H.edges.size.asnumpy()          # array([3, 3, 2, 4, 5, 2])
H.nodes.filterby("degree", 3)   # nodes 1, 3, 4

# visualize
pos = xgi.barycenter_spring_layout(H, seed=1)
xgi.draw(H, pos=pos)

XGI-DATA

XGI-DATA is a curated collection of 50+ real-world higher-order datasets (from face-to-face contacts and emails to coauthorships, legislation, and ecology), which can be loaded in one line with xgi.load_xgi_data().

Contribute

Contributions of any size are welcome, and we're happy to help! To report a bug or request a feature, open an issue. For more, see the contributing guide.

Join the community on Zulip and follow XGI on Bluesky.

Cite

We believe that quality software is important for supporting research. To demonstrate the value of XGI, we ask that you cite the XGI paper in your work. You can also use the "Cite this repository" button on GitHub.

Landry, N. W., Lucas, M., Iacopini, I., Petri, G., Schwarze, A., Patania, A., & Torres, L. (2023). XGI: A Python package for higher-order interaction networks. Journal of Open Source Software, 8(85), 5162.

@article{Landry_XGI_2023,
    author = {Landry, Nicholas W. and Lucas, Maxime and Iacopini, Iacopo and Petri, Giovanni and Schwarze, Alice and Patania, Alice and Torres, Leo},
    title = {{XGI: A Python package for higher-order interaction networks}},
    doi = {10.21105/joss.05162},
    journal = {Journal of Open Source Software},
    publisher = {The Open Journal},
    year = {2023},
    month = may,
    volume = {8},
    number = {85},
    pages = {5162},
    url = {https://doi.org/10.21105/joss.05162},
}

License

Released under the 3-Clause BSD license.

Support

See details here.

Looking for something else? See this list of other higher-order network software.