Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/pik-copan/pyunicorn

Unified Complex Network and Recurrence Analysis Toolbox
https://github.com/pik-copan/pyunicorn

Last synced: 3 months ago
JSON representation

Unified Complex Network and Recurrence Analysis Toolbox

Awesome Lists containing this project

README 

        

=========

pyunicorn

=========



.. image:: https://app.travis-ci.com/pik-copan/pyunicorn.svg?branch=master

  :target: https://app.travis-ci.com/github/pik-copan/pyunicorn

.. image:: https://codecov.io/gh/pik-copan/pyunicorn/branch/master/graph/badge.svg

  :target: https://codecov.io/gh/pik-copan/pyunicorn



About

=====

``pyunicorn`` (**Uni**\ fied **Co**\ mplex Network and **R**\ ecurre\ **N**\ ce

analysis toolbox) is an object-oriented Python package for the advanced analysis

and modeling of complex networks. Beyond the standard **measures of complex

network theory** (such as *degree*, *betweenness* and *clustering coefficients*), it

provides some uncommon but interesting statistics like *Newman's random walk

betweenness*. ``pyunicorn`` also provides novel **node-weighted** *(node splitting invariant)*

network statistics, measures for analyzing networks of **interacting/interdependent

networks**, and special tools to model **spatially embedded** complex networks.



Moreover, ``pyunicorn`` allows one to easily *construct networks* from uni- and

multivariate time series and event data (**functional/climate networks** and

**recurrence networks**). This involves linear and nonlinear measures of

**time series analysis** for constructing functional networks from multivariate data

(e.g., *Pearson correlation*, *mutual information*, *event synchronization* and *event

coincidence analysis*). ``pyunicorn`` also features modern techniques of

nonlinear analysis of time series (or pairs thereof), such as *recurrence

quantification analysis* (RQA), *recurrence network analysis* and *visibility

graphs*.



``pyunicorn`` is **fast**, because all costly computations are performed in

compiled C code. It can handle **large networks** through the

use of sparse data structures. The package can be used interactively, from any

Python script, and even for parallel computations on large cluster architectures.

For information about individual releases,

see our `CHANGELOG `_ and `CONTRIBUTIONS `_.



License

-------

``pyunicorn`` is `BSD-licensed `_ (3 clause).



Reference

---------

*Please acknowledge and cite the use of this software and its authors when

results are used in publications or published elsewhere. You can use the

following reference:*



    J.F. Donges, J. Heitzig, B. Beronov, M. Wiedermann, J. Runge, Q.-Y. Feng,

    L. Tupikina, V. Stolbova, R.V. Donner, N. Marwan, H.A. Dijkstra, and J.

    Kurths.

    **"Unified functional network and nonlinear time series analysis for complex

    systems science: The pyunicorn package"**.

    Chaos 25, 113101 (2015), `doi:10.1063/1.4934554

    `_, Preprint: `arxiv.org:1507.01571

    `_ [physics.data-an].



Funding

-------

The development of ``pyunicorn`` has been supported by various funding sources,

notably the `German Federal Ministry for Education and Research

`_ (projects `GOTHAM

`_ and `CoSy-CC2

`_), the `Leibniz Association

`_ (projects `ECONS

`_ and `DominoES

`_),

the `German National Academic Foundation `_,

and the `Stordalen Foundation `_ via the

`Planetary Boundary Research Network

`_ (PB.net) among

others.



Mailing list

------------

Not implemented yet.



Getting Started

===============



Installation

------------

Official releases

.................

`Stable releases `_ can be

installed directly from the `Python Package Index (PyPI)

`_::



    $> pip install pyunicorn



Alternatively, source distributions can be downloaded from the

`GitHub Releases `_.



On **Windows**, please *first* install the latest version of the `Microsoft C++ Build

Tools `_, which is required for

compiling Cython modules.



Current development version

...........................

In order to use a `newer version `_,

please follow the ``pip`` instructions for installing from `version control

`_

or from a `local source tree

`_.



Dependencies

............

``pyunicorn`` is implemented in `Python 3 `_ /

`Cython 3 `_, is `tested

`_ on *Linux*, *macOS*

and *Windows*, and relies on the following packages:



- Required:



  - `numpy `_, `scipy `_

  - `python-igraph `_ (for ``Network``)

  - `h5netcdf `_ (for ``Data``, ``NetCDFDictionary``)

  - `tqdm `_ (for progress bars)



- Optional:



  - `Matplotlib `_,

    `Cartopy `_

    (for plotting features)

  - `mpi4py `_

    (for parallelizing costly computations)

  - `Sphinx `_

    (for generating documentation)



Documentation

-------------

For extensive HTML documentation, jump right to the `homepage

`_. In a local source tree,

HTML and PDF documentation can be generated using ``Sphinx``::



    $> pip install .[docs]

    $> cd docs; make clean html latexpdf



Development

===========



Test suite

----------

Before committing changes or opening a pull request (PR) to the code base,

please make sure that all tests pass. The test suite is managed by `tox

`_ and is configured to use system-wide packages

when available. Install the test dependencies as follows::



    $> pip install -e .[tests]



The test suite can be run from anywhere in the project tree by issuing::



    $> tox



To display the defined test environments and target them individually::



    $> tox -l

    $> tox -e style,lint,test,docs



To test individual files::



    $> flake8 src/pyunicorn/core/network.py     # style check

    $> pylint src/pyunicorn/core/network.py     # static code analysis

    $> pytest tests/test_core/test_network.py   # unit tests