XGI

CompleX Group Interactions (XGI) is a Python package for the representation, manipulation, and study of the structure, dynamics, and functions of complex systems with group (higher-order) interactions.

Installation

XGI runs on Python 3.7 or higher.

To install the latest version of XGI, run the following command:

$ pip install xgi

To install this package locally:

Clone this repository
Navigate to the folder on your local machine
Run the following command:
```
$ pip install -e .["all"]
```

Getting Started

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

Contributing

Contributions are always welcome. Please report any bugs that you find here. Or, even better, fork the repository on GitHub and create a pull request (PR). We welcome all changes, big or small, and we will help you make the PR if you are new to git (just ask on the issue and/or see our contributing guidelines.

How to Cite

We acknowledge the importance of good software to support research, and we note that research becomes more valuable when it is communicated effectively. To demonstrate the value of XGI, we ask that you cite XGI in your work. Currently, the best way to cite XGI is to go to our repository page and click the "cite this repository" button on the right sidebar. This will generate a citation in your preferred format, and will also integrate well with citation managers.