Note

This documents the development version of NetworkX. Documentation for the current release can be found here.

networkx.drawing.layout.circular_layout

circular_layout(G, scale=1, center=None, dim=2)[source]

Position nodes on a circle.

Parameters
  • G (NetworkX graph or list of nodes) – A position will be assigned to every node in G.

  • scale (number (default: 1)) – Scale factor for positions.

  • center (array-like or None) – Coordinate pair around which to center the layout.

  • dim (int) – Dimension of layout. If dim>2, the remaining dimensions are set to zero in the returned positions. If dim<2, a ValueError is raised.

Returns

pos – A dictionary of positions keyed by node

Return type

dict

Raises

ValueError – If dim < 2

Examples

>>> G = nx.path_graph(4)
>>> pos = nx.circular_layout(G)

Notes

This algorithm currently only works in two dimensions and does not try to minimize edge crossings.