Skip to content

Latest commit

 

History

History
72 lines (55 loc) · 3.98 KB

README.md

File metadata and controls

72 lines (55 loc) · 3.98 KB
Raw

SimpleHypergraphs.jl

A simple hypergraphs package for the Julia programming language.

Documentation Build Status


tutorial		 Build Status Coverage Status
Linux and macOS

Installation instructions

Prerequisites for plotting

Simplehypergraphs can optionally use (among other options) the Python's hypernetx library so if you want the hypernetx plotting to work you need to install it first along with its all dependent libraries. In Julia command line REPL press ] for the Julia package manager and run:

(v1.5) pkg> add PyCall Conda

Now press backspace to exit the package manager and run the following installation code:

using PyCall
using Conda
Conda.runconda(`install matplotlib --yes`)
Conda.runconda(`install networkx --yes`)
Conda.runconda(`install pandas --yes`)
run(`$(PyCall.python) -m pip install hypernetx==1.2.5`)

In case of throubleshooting to check whether hypernetx is properly configured with Julia you can always run the following test:

using PyCall
pyimport("hypernetx")

For plotting we also use the Jupyter notebook. The installation instructions are here

Note that recently a new version of hypernetx has been released (2.0.0), however as of today SimpleHyprgraphs.jl is integrated with the previous versions up to 1.2.5.

Installation

In Julia command line REPL press ] for the Julia package manager and run:

(v1.5) pkg> add SimpleHypergraphs

Documentation

  • Tutorial — for a quick start with the library see our Jupyter Notebook tutorial (raw *.ipynb version can be also downloaded)
  • STABLE — documentation of the most recently tagged version.
  • DEV — documentation of the development version.
  • A Game of Thrones use case — check out how you can exploit the library to gather insights into real-world networks through a case study of the Game of Thrones TV series (raw *.ipynb version can be also downloaded)

Citing

If you use this library in your research please cite us:

Antelmi, A., Cordasco, G., Kamiński, B., Prałat, P., Scarano, V., Spagnuolo, C. and Szufel, P., "Analyzing, exploring, and visualizing complex networks via hypergraphs using SimpleHypergraphs. jl.", Internet Mathematics, vol. 1 iss. 1 (2020), March 31, 2020

The full paper is available at https://doi.org/10.24166/im.01.2020

Acknowledgement

The research is financed by NAWA - The Polish National Agency for Academic Exchange.