_images/logo.svg

About

The CompleX Group Interactions (XGI) library provides data structures and algorithms for modeling and analyzing complex systems with group (higher-order) interactions.

Installation

To install and use XGI as an end user, execute

pip install xgi

To install for development purposes, first clone the repository and then execute

pip install -e .['all']

If that command does not work, you may try the following instead

pip install -e .\[all\]

XGI was developed and tested for Python 3.7-3.10 on Mac OS, Windows, and Ubuntu.

Academic References

Contributing

If you want to contribute to this project, please make sure to read the code of conduct and the contributing guidelines.

The best way to contribute to XGI is by submitting a bug or request a new feature by opening a new issue.

To get more actively involved, you are invited to browse the issues page and choose one that you can work on. The core developers will be happy to help you understand the codebase and any other doubts you may have while working on your contribution.

If you are interested in the daily goings-on of XGI, you are invited to join our Zulip channel.

Contributors

The core XGI team members:

  • Nicholas Landry

  • Leo Torres

  • Maxime Lucas

  • Iacopo Iacopini

  • Giovanni Petri

  • Alice Patania

Other contributors:

  • Tim LaRock

License

This project is licensed under the BSD 3-Clause License.

Copyright (C) 2021 XGI Developers