XGI is a Python package for higher-order networks.
Project description
XGI is a Python package for higher-order networks.
CompleX Group Interactions (XGI) provides an ecosystem 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.8 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.
Corresponding Data
A number of higher-order datasets are available in the XGI-DATA repository and can be easily accessed with the load_xgi_data() function.
Contributing
If you want to contribute to this project, please make sure to read the contributing guidelines. We expect respectful and kind interactions by all contributors and users as laid out in our code of conduct.
The XGI community always welcomes contributions, no matter how small. We’re happy to help troubleshoot XGI issues you run into, assist you if you would like to add functionality or fixes to the codebase, or answer any questions you may have.
Some concrete ways that you can get involved:
Get XGI updates by following the XGI Twitter account, signing up for our mailing list, or starring this repository.
Spread the word when you use XGI by sharing with your colleagues and friends.
Request a new feature or report a bug by raising a new issue.
Create a Pull Request (PR) to address an open issue or add a feature.
Join our Zulip channel to be a part of the daily goings-on of XGI.
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.
License
Released under the 3-Clause BSD license (see the license file)
Copyright (C) 2021-2023 XGI Developers
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
