ekalosak / nx3d

A 3D plotting library for networkx

nx3d

A 3D plotting library for networkx built on panda3d.

Installation

pip install nx3d

Check your installation

The four nx.Graph classes

nx.Graph demo

python -m nx3d

nx.DiGraph demo

python -m nx3d dir

nx.MultiGraph demo

python -m nx3d mul

nx.MultiDiGraph demo

python -m nx3d mul dir

Dynamic graph processes

Diffusion demo

python -m nx3d diffusion watt nolabel

Game of Life demo

python -m nx3d life nofilter

Usage

In your Python code:

import networkx as nx
import nx3d

g = nx.frucht_graph()
nx3d.plot(g)

Next steps

Check out the docs for tutorials, how-to-guides, explanations, and reference material.

nx3d's Issues

Docstrings auto-updated with type annotations by pre-commit

Dynamic positions

• set pos via graph attr
• demo update via state_trans_func

export to sty

mouse click object -> event

Add an interface for handling edge-click and node-click events; also click and drag;
Default click should highlight node and freeze its pos.
Default click and drag should update remaining pos with spring algorithm;

Instead of 'val' use 'weight'

easier interoperability with nx algorithms that use 'weight' as a special graph attribute

also if ^ is indeed true, that 'weight' is an nx SGA, update the docs Usage SGA explanation with this information.

Add tutorial for basic interface

Cover the node and edge labels and colors; don't include the graph attribute interface

MultiDiGraph support

See #11 for detail

Initial radius for camera is wrong

https://github.com/ekalosak/nx3d/blob/main/src/nx3d/core.py#L297
should use tan not atan

Library of common graph attribute initializers

e.g. 2d grid initialized with 'pos'

Add tutorial for graph attribute interface

Update RTD index page

• What it is, what it isn't
• Design principles (graph attribute controls render, then defaults)
• Usage

default camera spin

It'd be better to have the demo start spinning rather than static.
If the user hasn't given keyboard input in the last 3.5 seconds, start spinning.

CD to release `dev` branch to `main` every Monday

This would be nice to have as a GitHub Action

Variable graphs for demos

instead of just the frucht graph, allow any nx graph initializer (though for GoL this will require scaling the life/death rules relative to degree of node)

Implement to_rgb

Render to an RGB array of size (x, y, 3)

Make graph rotatable

Currently wasd controls the camera.
Make ijkl rotate the graph itself.

To do so:

• Parent the p3d.nodes to a p3d.node at the center of mass.
• Then add task or event for handling ijkl input.
• You'll be able to tell it works if when using ijkl the graph moves but the lighting (which is relative to the scene) does not.

This enables p3d physics (change angle of p3d nodes relative to z axis).

DiGraph support

In progress, see implement-digraph branch

Dynamic 3d models for nodes

• default argument to Nx3D e.g. icosphere, icosphere_2, pyramid, cube
• set via "marker" attribute
• demo with state_trans_func

Dynamic visibility

graph attribute support 'visible' binary mask

Multigraph labels plot on top of each other

Both demos to support M, D, and MD

diffusion over multigraphs and digraphs etc is straightforward
you'll have to change GoL rules a little to make it work over a digraph or multigraph - scaling life/death rules relative to node degree seems like a reasonable approach

Better interface for controlling the panda3d window backend

Passing kwargs to ShowBase is not user friendly or well controlled.
Also catch and provide better error messages when e.g. X is not available.
Barfing with complicated panda3d error is not user friendly.

Game of life example

• 2d grid
• 3d grid
• sphere
• cylinder

a bug

OSError: Could not load model file(s): [WindowsPath('C:/Users/admin/AppData/Local/Programs/Python/Python39/lib/site-packages/nx3d/data/icosphere.bam')]

Camera to use panda3d.lookAt center of render

refactor self-rolled trig to panda3d. lookAt

Procedural mesh generation

https://pymesh.readthedocs.io/en/latest/api_procedural_mesh_generation.html

Implement to_text using ansi drawing package

https://github.com/asciimoo/drawille

use lookAt rather than self-rolled trigonometry

Without this, the framerate will tank for dynamic positions.

Move contribution instructions to RTD

Keep the README slim.

• Introduction
• Metadata (badges)
• Installation
• Quick-start
• Where to go next

Dynamic graph geometry

Ability to add and remove nodes and edges over time

Refactor graph element init to node and edge factories

https://networkx.org/documentation/stable/reference/classes/multigraph.html
ctrl+f "node_dict_factory"

my_multi_graph.graph["k"] is required for Multi and MultiDiGraph classes

This "k" is the max number of edges between two nodes in my_graph; it's used to calculate the rotation required for the 3d render edges to be legible. It must not be a required pre-initialization attribute - which it currently is.

Add GUI control function to Nx3D __init__

User should be able to control some GUI output text based on the contents of their graph. Signature will probably be something like

  gui_control_func: Callable[Graph, list[str]]

MultiGraph support

Need to be able to plot multi-graphs, requires bent edges so they don't overlap

Better keyboard support

• press esc to quit
• press r to reset camera position
• press t to toggle default spin
• press h to toggle GUI
• press m to toggle mouse control

Render to GIF rather than to popup

Requires default camera "tumble"