Note

This documentation was generated on Sep 29, 2024 for package release 1.5.2.

networkx-gdf

PyPI version Documentation Status Downloads Downloads License

NetworkX-GDF extends the NetworkX library to support GDF (Graph Data Format) files.

It provides two functions to read and write GDF files, which are used to store graph data in a tabular format. The package is designed to be lightweight on requirements and easy to use.

Install

The package supports Python 3.7++ and is readily available from PyPI:

$ pip install networkx-gdf

Quick start

The following is a quick example of the package in action, covering its basic functionality.

>>> from networkx_gdf import read_gdf, write_gdf
>>>
>>> # Reads NetworkX graph object from file.
>>> G = read_gdf("input_file.gdf")
>>>
>>> # Writes NetworkX graph object to file.
>>> write_gdf(G, "output_file.gdf")

For details on the functions above and the package’s usage, please refer to the API Reference page.

See also

The package’s GitHub repository for the latest updates and issues. Contributions are welcome!

Cite

If this package is useful for your research, please kindly consider citing the NetworkX paper:

Hagberg, Aric A., Schult, Daniel A., Swart, Pieter J. (2008). ‘’Exploring Network Structure, Dynamics, and Function using NetworkX’’. In: Proceedings of the 7th Python in Science Conference (SciPy2008). Pasadena (CA), USA, August 2008.

@inproceedings{networkx2008,
   author    = {Aric A. Hagberg and Daniel A. Schult and Pieter J. Swart},
   title     = {Exploring Network Structure, Dynamics, and Function using NetworkX},
   booktitle = {Proceedings of the 7th Python in Science Conference},
   pages     = {11--15},
   address   = {Pasadena, CA USA},
   year      = {2008},
   editor    = {Ga\"el Varoquaux and Travis Vaught and Jarrod Millman},
   url       = {https://conference.scipy.org/proceedings/scipy2008/paper_2/},
}