Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

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

Open
andrewtarzia opened this issue Apr 12, 2022 · 0 comments

Comments

@andrewtarzia
Copy link
Collaborator

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant