Skip to content

Idea for a visualisation of topologies in docs and for topology generation #431

@andrewtarzia

Description

@andrewtarzia

The software would take a ToplogyGraph class from stk and draw:

  • spheres at each vertex, labelled or coloured by Vertex class and ID (other information can be added to label)
  • lines at each edge, again labelled by ID and probably periodicity
  • Each FG or connection should be labelled to
  • an XYZ axis somewhere

A good feature is if there was a way to produce very nice images of these topologies for abstract figures in papers/docs.

I imagine an interface that takes a TopologyGraph object.

This could be accessed as a link in the stk docs for each topology graph - similar to the current chemical structure examples.

The main end goal is a GUI that lets you write a TopologyGraph class and draws it - in real time or via an "update" button. Therefore, making the topology definition for a user much much easier.

The main concern is for topologies like linear polymers, where the graph is defined by the class init. The user of this visualiser must have access to this as well to be able to draw a linear polymer of whatever type they are keen on.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions