| Name | xgi JSON |
| Version |
0.9.2
JSON |
| download |
| home_page | None |
| Summary | XGI is a Python package for higher-order networks. |
| upload_time | 2024-11-12 22:52:26 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.9 |
| license | XGI is distributed with the 3-clause BSD license. Copyright (C) 2024, XGI Developers All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the names of the XGI Developers nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. --------------------------------- License Tensor methods for nonuniform hypergraphs * Tensor methods functionality for the CompleX Group Interactions library Copyright 2023, 2024 Battelle Memorial Institute Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS “AS IS” AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. |
| keywords |
networks
higher-order
higher-order network
hypergraph
simplicial complex
network science
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
<img src='https://github.com/xgi-org/xgi/blob/main/logo/logo.svg' alt="XGI" width='50%'></img>
[](https://www.repostatus.org/#active)
[](https://www.repostatus.org/#active)
[](https://github.com/xgi-org/xgi/actions?query=workflow%3A%22test%22)
[](https://codecov.io/gh/xgi-org/xgi)
[](https://github.com/xgi-org/xgi/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Issue%22)
[](https://doi.org/10.21105/joss.05162)
[](https://github.com/pyOpenSci/software-review/issues/115)
* [**Source**](https://github.com/xgi-org/xgi)
* [**Bug reports**](https://github.com/xgi-org/xgi/issues)
* [**GitHub Discussions**](https://github.com/xgi-org/xgi/discussions)
* [**Documentation**](https://xgi.readthedocs.io)
* [**Contribute**](https://xgi.readthedocs.io/en/stable/contribute.html)
* [**Projects using XGI**](https://xgi.readthedocs.io/en/stable/using-xgi.html)
Sign up for our [mailing list](http://eepurl.com/igE6ez) and follow XGI on [Twitter](https://twitter.com/xginets) or [Mastodon](https://mathstodon.xyz/@xginets)!
### Table of Contents: ###
- [What is XGI?](#what-is-xgi)
- [Installation](#installation)
- [Getting Started](#getting-started)
- [XGI-DATA](#xgi-data)
- [How to Contribute](#how-to-contribute)
- [How to Cite](#how-to-cite)
- [License](#license)
- [Funding](#funding)
- [Other Resources](#other-resources)
## What is XGI?<a id="what-is-xgi"></a>
Comple**X** **G**roup **I**nteractions (**XGI**) is a Python package for higher-order networks (If you want more information on what higher-order networks are, see our [brief introduction](https://xgi.readthedocs.io/en/stable/higher-order.html)).
**XGI is a software designed to streamline working with higher-order networks from start to finish**. XGI can
* Create synthetic datasets from many **generative models**
* **Read and write** higher-order datasets in a user-friendly way
* Represent **hypergraphs, directed hypergraphs, and simplicial complexes** with efficient and flexible data structures
* Analyze higher-order networks with **measures and algorithms**
* **Manipulate node and edge statistics** in a flexible and customizable way.
* Draw higher-order networks in a variety of **visually striking ways** (See our [gallery](https://xgi.readthedocs.io/en/stable/gallery.html) for several examples.)
## Installation<a id="installation"></a>
XGI runs on Python 3.9 or higher.
To install the latest version of XGI, run the following command:
```sh
pip install xgi
```
To install this package locally:
* Clone this repository
* Navigate to the folder on your local machine
* Run the following command:
```sh
pip install -e .["all"]
```
* If that command does not work, you may try the following instead
````zsh
pip install -e ."[all]"
````
For more installation options, see the [guide](https://github.com/xgi-org/xgi/blob/main/requirements/README.md).
## Getting Started<a id="getting-started"></a>
To get started, take a look at the [user guides](https://xgi.readthedocs.io/en/stable/user_guides.html) illustrating the library's basic functionality.
## XGI-DATA<a id="xgi-data"></a>
A number of higher-order datasets are available in the [XGI-DATA repository](https://github.com/xgi-org/xgi-data) and can be easily accessed with the `load_xgi_data()` function.
## How to Contribute<a id="how-to-contribute"></a>
If you want to contribute to this project, please make sure to read the
[contributing guidelines](https://github.com/xgi-org/xgi/blob/main/HOW_TO_CONTRIBUTE.md). We expect respectful and kind interactions by all contributors and users as laid out in our [code of conduct](https://github.com/xgi-org/xgi/blob/main/CODE_OF_CONDUCT.md).
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](https://twitter.com/xginets) account, signing up for our [mailing list](http://eepurl.com/igE6ez), 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](https://github.com/xgi-org/xgi/issues/new).
* **Create a Pull Request (PR)** to address an [open issue](https://github.com/xgi-org/xgi/issues) or add a feature.
* **Join our [Zulip channel](https://xgi.zulipchat.com/join/7agfwo7dh7jo56ppnk5kc23r/)** to be a part of the daily goings-on of XGI.
## How to Cite<a id="how-to-cite"></a>
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 the XGI [paper](https://doi.org/10.21105/joss.05162) in your work. You can cite XGI either by going to our repository page [repository page](https://github.com/xgi-org/xgi) (if you haven't already) and clicking the "cite this repository" button on the right sidebar (which will generate a citation in your preferred format) or by copying the following BibTeX entry:
```
@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<a id="license"></a>
Released under the 3-Clause BSD license (see [`LICENSE.md`](https://github.com/xgi-org/xgi/blob/main/LICENSE.md))
Copyright (C) 2021-2024 XGI Developers
## Funding<a id="funding"></a>
The XGI package has been supported by NSF Grant 2121905, ["HNDS-I: Using Hypergraphs to Study Spreading Processes in Complex Social Networks"](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2121905).
## Other Resources<a id="other-resources"></a>
This library may not meet your needs and if this is this case, consider checking out our [list of other resources](https://github.com/xgi-org/xgi/blob/main/OTHER_RESOURCES.md).
Raw data
{
"_id": null,
"home_page": null,
"name": "xgi",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.9",
"maintainer_email": "XGI Developers <nicholas.landry@virginia.edu>",
"keywords": "networks, higher-order, higher-order network, hypergraph, simplicial complex, network science",
"author": null,
"author_email": "XGI Developers <nicholas.landry@virginia.edu>",
"download_url": "https://files.pythonhosted.org/packages/9c/49/571ac8be0d4656f23bba44f1ea7c7216e072d8f3758fddcbbf9cda534a70/xgi-0.9.2.tar.gz",
"platform": null,
"description": "<img src='https://github.com/xgi-org/xgi/blob/main/logo/logo.svg' alt=\"XGI\" width='50%'></img>\n\n[](https://www.repostatus.org/#active)\n[](https://www.repostatus.org/#active)\n[](https://github.com/xgi-org/xgi/actions?query=workflow%3A%22test%22)\n[](https://codecov.io/gh/xgi-org/xgi)\n[](https://github.com/xgi-org/xgi/issues?q=is%3Aopen+is%3Aissue+label%3A%22Good+First+Issue%22)\n[](https://doi.org/10.21105/joss.05162)\n[](https://github.com/pyOpenSci/software-review/issues/115)\n\n* [**Source**](https://github.com/xgi-org/xgi)\n* [**Bug reports**](https://github.com/xgi-org/xgi/issues)\n* [**GitHub Discussions**](https://github.com/xgi-org/xgi/discussions)\n* [**Documentation**](https://xgi.readthedocs.io)\n* [**Contribute**](https://xgi.readthedocs.io/en/stable/contribute.html)\n* [**Projects using XGI**](https://xgi.readthedocs.io/en/stable/using-xgi.html)\n\nSign up for our [mailing list](http://eepurl.com/igE6ez) and follow XGI on [Twitter](https://twitter.com/xginets) or [Mastodon](https://mathstodon.xyz/@xginets)!\n\n### Table of Contents: ###\n- [What is XGI?](#what-is-xgi)\n- [Installation](#installation)\n- [Getting Started](#getting-started)\n- [XGI-DATA](#xgi-data)\n- [How to Contribute](#how-to-contribute)\n- [How to Cite](#how-to-cite)\n- [License](#license)\n- [Funding](#funding)\n- [Other Resources](#other-resources)\n\n## What is XGI?<a id=\"what-is-xgi\"></a>\n\nComple**X** **G**roup **I**nteractions (**XGI**) is a Python package for higher-order networks (If you want more information on what higher-order networks are, see our [brief introduction](https://xgi.readthedocs.io/en/stable/higher-order.html)).\n\n**XGI is a software designed to streamline working with higher-order networks from start to finish**. XGI can\n* Create synthetic datasets from many **generative models**\n* **Read and write** higher-order datasets in a user-friendly way\n* Represent **hypergraphs, directed hypergraphs, and simplicial complexes** with efficient and flexible data structures\n* Analyze higher-order networks with **measures and algorithms**\n* **Manipulate node and edge statistics** in a flexible and customizable way.\n* Draw higher-order networks in a variety of **visually striking ways** (See our [gallery](https://xgi.readthedocs.io/en/stable/gallery.html) for several examples.)\n\n## Installation<a id=\"installation\"></a>\nXGI runs on Python 3.9 or higher.\n\nTo install the latest version of XGI, run the following command:\n```sh\npip install xgi\n```\n\nTo install this package locally:\n* Clone this repository\n* Navigate to the folder on your local machine\n* Run the following command:\n```sh\npip install -e .[\"all\"]\n```\n* If that command does not work, you may try the following instead\n````zsh\npip install -e .\"[all]\"\n````\nFor more installation options, see the [guide](https://github.com/xgi-org/xgi/blob/main/requirements/README.md).\n\n\n## Getting Started<a id=\"getting-started\"></a>\nTo get started, take a look at the [user guides](https://xgi.readthedocs.io/en/stable/user_guides.html) illustrating the library's basic functionality.\n\n\n## XGI-DATA<a id=\"xgi-data\"></a>\nA number of higher-order datasets are available in the [XGI-DATA repository](https://github.com/xgi-org/xgi-data) and can be easily accessed with the `load_xgi_data()` function.\n\n\n## How to Contribute<a id=\"how-to-contribute\"></a>\nIf you want to contribute to this project, please make sure to read the\n[contributing guidelines](https://github.com/xgi-org/xgi/blob/main/HOW_TO_CONTRIBUTE.md). We expect respectful and kind interactions by all contributors and users as laid out in our [code of conduct](https://github.com/xgi-org/xgi/blob/main/CODE_OF_CONDUCT.md).\n\nThe 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.\n\nSome concrete ways that you can get involved:\n\n* **Get XGI updates** by following the XGI [Twitter](https://twitter.com/xginets) account, signing up for our [mailing list](http://eepurl.com/igE6ez), or starring this repository.\n* **Spread the word** when you use XGI by sharing with your colleagues and friends.\n* **Request a new feature or report a bug** by raising a [new issue](https://github.com/xgi-org/xgi/issues/new).\n* **Create a Pull Request (PR)** to address an [open issue](https://github.com/xgi-org/xgi/issues) or add a feature.\n* **Join our [Zulip channel](https://xgi.zulipchat.com/join/7agfwo7dh7jo56ppnk5kc23r/)** to be a part of the daily goings-on of XGI.\n\n\n## How to Cite<a id=\"how-to-cite\"></a>\nWe 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 the XGI [paper](https://doi.org/10.21105/joss.05162) in your work. You can cite XGI either by going to our repository page [repository page](https://github.com/xgi-org/xgi) (if you haven't already) and clicking the \"cite this repository\" button on the right sidebar (which will generate a citation in your preferred format) or by copying the following BibTeX entry:\n```\n@article{Landry_XGI_2023,\n author = {Landry, Nicholas W. and Lucas, Maxime and Iacopini, Iacopo and Petri, Giovanni and Schwarze, Alice and Patania, Alice and Torres, Leo},\n title = {{XGI: A Python package for higher-order interaction networks}},\n doi = {10.21105/joss.05162},\n journal = {Journal of Open Source Software},\n publisher = {The Open Journal},\n year = {2023},\n month = may,\n volume = {8},\n number = {85},\n pages = {5162},\n url = {https://doi.org/10.21105/joss.05162},\n}\n```\n\n## License<a id=\"license\"></a>\nReleased under the 3-Clause BSD license (see [`LICENSE.md`](https://github.com/xgi-org/xgi/blob/main/LICENSE.md))\n\nCopyright (C) 2021-2024 XGI Developers\n\n## Funding<a id=\"funding\"></a>\nThe XGI package has been supported by NSF Grant 2121905, [\"HNDS-I: Using Hypergraphs to Study Spreading Processes in Complex Social Networks\"](https://www.nsf.gov/awardsearch/showAward?AWD_ID=2121905).\n\n## Other Resources<a id=\"other-resources\"></a>\nThis library may not meet your needs and if this is this case, consider checking out our [list of other resources](https://github.com/xgi-org/xgi/blob/main/OTHER_RESOURCES.md).\n",
"bugtrack_url": null,
"license": "XGI is distributed with the 3-clause BSD license. Copyright (C) 2024, XGI Developers All rights reserved. Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: * Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. * Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. * Neither the names of the XGI Developers nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. --------------------------------- License Tensor methods for nonuniform hypergraphs * Tensor methods functionality for the CompleX Group Interactions library Copyright 2023, 2024 Battelle Memorial Institute Redistribution and use in source and binary forms, with or without modification, are permitted provided that the following conditions are met: 1. Redistributions of source code must retain the above copyright notice, this list of conditions and the following disclaimer. 2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions and the following disclaimer in the documentation and/or other materials provided with the distribution. 3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse or promote products derived from this software without specific prior written permission. THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \u201cAS IS\u201d AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.",
"summary": "XGI is a Python package for higher-order networks.",
"version": "0.9.2",
"project_urls": {
"Bug Reports": "https://github.com/xgi-org/xgi/issues",
"Documentation": "https://xgi.readthedocs.io/en/stable/",
"GitHub Discussions": "https://github.com/xgi-org/xgi/discussions",
"PyPI": "https://pypi.org/project/xgi/",
"Source": "https://github.com/xgi-org/xgi"
},
"split_keywords": [
"networks",
" higher-order",
" higher-order network",
" hypergraph",
" simplicial complex",
" network science"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "40853ec09993413846fba47b9c17deb58610e62fa6f430dbe2aab84d51699224",
"md5": "b42e760ecbcd803def675f3ad45f25bf",
"sha256": "380ce1ef7d5168d4ae683e87d841c3f34e105d76e85df99e56436c25c9f90907"
},
"downloads": -1,
"filename": "xgi-0.9.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b42e760ecbcd803def675f3ad45f25bf",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.9",
"size": 609832,
"upload_time": "2024-11-12T22:52:24",
"upload_time_iso_8601": "2024-11-12T22:52:24.219500Z",
"url": "https://files.pythonhosted.org/packages/40/85/3ec09993413846fba47b9c17deb58610e62fa6f430dbe2aab84d51699224/xgi-0.9.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "9c49571ac8be0d4656f23bba44f1ea7c7216e072d8f3758fddcbbf9cda534a70",
"md5": "2268e7ebed953957948a31f0482d612a",
"sha256": "edf1ac7fa68230791043bc7357ef66107bdc6bc480347cbe16bc96d54a11da47"
},
"downloads": -1,
"filename": "xgi-0.9.2.tar.gz",
"has_sig": false,
"md5_digest": "2268e7ebed953957948a31f0482d612a",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.9",
"size": 562757,
"upload_time": "2024-11-12T22:52:26",
"upload_time_iso_8601": "2024-11-12T22:52:26.245858Z",
"url": "https://files.pythonhosted.org/packages/9c/49/571ac8be0d4656f23bba44f1ea7c7216e072d8f3758fddcbbf9cda534a70/xgi-0.9.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-11-12 22:52:26",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "xgi-org",
"github_project": "xgi",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"lcname": "xgi"
}
