Science Score: 44.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
✓CITATION.cff file
Found CITATION.cff file -
✓codemeta.json file
Found codemeta.json file -
✓.zenodo.json file
Found .zenodo.json file -
○DOI references
-
○Academic publication links
-
○Committers with academic emails
-
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (16.8%) to scientific vocabulary
Keywords
Repository
Library for epidemics on hypergraphs
Basic Info
- Host: GitHub
- Owner: nwlandry
- License: other
- Language: Python
- Default Branch: main
- Homepage: https://hypercontagion.readthedocs.io
- Size: 3.86 MB
Statistics
- Stars: 12
- Watchers: 4
- Forks: 2
- Open Issues: 0
- Releases: 3
Topics
Metadata Files
README.md
HyperContagion
HyperContagion is a Python package for the simulation and visualization of contagion processes on complex systems with group (higher-order) interactions.
Table of Contents:
- Installation
- Getting Started
- Documentation
- Contributing
- How to Cite
- Code of Conduct
- License
- Funding
- Other Resources
Installation
HyperContagion runs on Python 3.8 or higher.
To install the latest version of HyperContagion, run the following command:
sh
pip install hypercontagion
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\]
Getting Started
To get started, take a look at the demos illustrating the library's basic functionality.
Documentation
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 HyperContagion, we ask that you cite HyperContagion in your work. Currently, the best way to cite HyperContagion is to go to our repository page (if you haven't already) 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.
Code of Conduct
License
Released under the 3-Clause BSD license (see LICENSE.md)
Copyright (C) 2021 HyperContagion Developers
Nicholas Landry nicholas.landry@colorado.edu
The HyperContagion library has copied or modified code from the EoN and Epipack libraries, the licenses of which can be found in our license file
Funding
The HyperContagion package has been supported by NSF Grant 2121905, "HNDS-I: Using Hypergraphs to Study Spreading Processes in Complex Social Networks".
Owner
- Name: Nicholas Landry
- Login: nwlandry
- Kind: user
- Location: Burlington, VT
- Company: University of Vermont
- Website: nwlandry.com
- Twitter: nwlandry
- Repositories: 4
- Profile: https://github.com/nwlandry
Citation (CITATION.cff)
# YAML 1.2
---
authors:
-
family-names: Landry
given-names: Nicholas
-
family-names: Miller
given-names: Joel
cff-version: "1.1.0"
license: "BSD-3"
message: "If you use this software, please cite it using these metadata."
title: hypercontagion
version: "0.1.2"
GitHub Events
Total
- Member event: 1
- Fork event: 1
Last Year
- Member event: 1
- Fork event: 1
Issues and Pull Requests
Last synced: 6 months ago
All Time
- Total issues: 0
- Total pull requests: 3
- Average time to close issues: N/A
- Average time to close pull requests: 2 days
- Total issue authors: 0
- Total pull request authors: 1
- Average comments per issue: 0
- Average comments per pull request: 0.0
- Merged pull requests: 3
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 0
- Pull requests: 0
- Average time to close issues: N/A
- Average time to close pull requests: N/A
- Issue authors: 0
- Pull request authors: 0
- Average comments per issue: 0
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
Pull Request Authors
- nwlandry (3)
Top Labels
Issue Labels
Pull Request Labels
Packages
- Total packages: 1
-
Total downloads:
- pypi 6 last-month
- Total dependent packages: 0
- Total dependent repositories: 0
- Total versions: 3
- Total maintainers: 1
pypi.org: hypercontagion
HyperContagion is a Python library for the simulation of contagion on complex systems with group (higher-order) interactions.
- Homepage: https://github.com/nwlandry/hypercontagion
- Documentation: https://hypercontagion.readthedocs.io/
- License: other
-
Latest release: 0.1.2
published about 3 years ago
Rankings
Maintainers (1)
Dependencies
- celluloid >=0.2.0
- networkx >=2.0
- numpy >=1.19
- xgi >=0.3
- black ==22.3.0 development
- isort ==5.10.1 development
- pre-commit >=2.12 development
- pylint >=2.10 development
- matplotlib >=3.3
- numpydoc >=1.1
- pillow >=8.2
- sphinx *
- sphinx-rtd-theme >=0.4.2
- sphinx_copybutton *
- twine >=3.4
- wheel >=0.36
- coverage >=6.0 test
- pytest >=6.2 test
- pytest-cov >=2.12 test
- jupyter >=1.0
- matplotlib >=3.3
- actions/checkout v2 composite
- actions/setup-python v2 composite