muxpack.py documentation

Muxpack is a Python package for working with large multi-layer or multiplex networks, for multiple periods e.g years. The main classes work on an edgelist representation of the network, and provide methods for creating, manipulating, and analyzing multiplex networks. It is designed to keep the data on disk and only load the necessary parts into memory, making it suitable for large networks that do not fit in memory.

Contents:

• Usage
  • Basic Examples
    • Read a MultiplexSeries
    • Add a filter
    • Select a multiplex for one period
• API Reference
  • MultiplexSeries
    • MultiplexSeries
      • MultiplexSeries.__init__()
      • MultiplexSeries.add_filter()
      • MultiplexSeries.collapse()
      • MultiplexSeries.collapse_to()
      • MultiplexSeries.edges
      • MultiplexSeries.get_multiplex()
      • MultiplexSeries.layers()
      • MultiplexSeries.multiplexes()
      • MultiplexSeries.periods()
      • MultiplexSeries.relationtypes
      • MultiplexSeries.save()
      • MultiplexSeries.to_csr_matrices()
      • MultiplexSeries.to_networkx()
      • MultiplexSeries.update_relationtypes()
      • MultiplexSeries.update_vertices()
      • MultiplexSeries.vertex_ids
      • MultiplexSeries.vertices
  • Multiplex
    • Multiplex
      • Multiplex.__init__()
      • Multiplex.edges
      • Multiplex.layers()
      • Multiplex.outdegree()
      • Multiplex.period
      • Multiplex.save()
      • Multiplex.to_csr_matrices()
      • Multiplex.to_csr_matrix()
      • Multiplex.to_networkx()
      • Multiplex.update_vertices()
      • Multiplex.vertices
  • Bipartite
    • Bipartite
      • Bipartite.__init__()
      • Bipartite.edges
      • Bipartite.project_to_dst()
      • Bipartite.project_to_src()
      • Bipartite.relationtype
      • Bipartite.role_dst
      • Bipartite.role_src
      • Bipartite.save()
  • Validation
    • check_edges()
    • check_vertices()
    • check_column_type()
  • Input / Output
    • read_multiplexseries()
    • save_multiplexseries()
    • read_multiplexseries()
    • save_multiplex()
    • save_multiplexseries()
    • save_bipartite()
    • read_bipartite()
  • Sparse matrices
    • to_csr_matrix()
    • to_period_csr_matrix()
  • NetworkX
    • to_MultiDiGraph()