API

Release:

0.8.0

Date:

Sep 17, 2024

pyunicorn consists of six subpackages, where the core and utils.mpi namespaces are to be accessed by calling import pyunicorn. The subpackage eventseries only contains one function and will be extended in one of the next versions. All subpackages except for utils directly export the classes defined in their submodules.

core

General network analysis and modeling.

• core.data
• core.geo_grid
• core.geo_network
• core.grid
• core.interacting_networks
• core.netcdf_dictionary
• core.network
• core.resistive_network
• core.spatial_network

climate

Constructing and analysing climate networks, related climate data analysis.

• climate.climate_data
• climate.climate_network
• climate.coupled_climate_network
• climate.coupled_tsonis
• climate.eventseries_climatenetwork
• climate.havlin
• climate.hilbert
• climate.map_plot
• climate.mutual_info
• climate.partial_correlation
• climate.rainfall
• climate.spearman
• climate.tsonis

timeseries

Recurrence plots, recurrence networks, multivariate extensions and visibility graph analysis of time series. Time series surrogates for significance testing.

• timeseries.cross_recurrence_plot
• timeseries.inter_system_recurrence_network
• timeseries.joint_recurrence_network
• timeseries.joint_recurrence_plot
• timeseries.recurrence_network
• timeseries.recurrence_plot
• timeseries.surrogates
• timeseries.visibility_graph

funcnet

Constructing and analysing general functional networks.

• funcnet.coupling_analysis
• funcnet.coupling_analysis_pure_python

eventseries

Analysis of event series.

• eventseries.event_series

utils

Parallelization, interactive network navigator, helpers.

• utils.mpi
• utils.navigator