pcdshub / pcdshub/lightpath

GUI: option to display a facility graph

Open
#166 4 comments 2 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
4
Forks
9
Avg merge
7d 14h
Merged PRs (30d)
1

Description

Current Behavior

Currently the only view of the facility is through a singular BeamPath, which is workable if you're not considering other beamlines

Possible Solution

A button that displays an image of the facility, based off the LightController.graph. Could condense nodes between branching nodes, with an option to expand a branch by clicking on it. It would be a good place to also show the beam path through the facility from beginning to end.

Context

Currently there is no way to see the facility layout within lightpath itself. We have been referring users to an facility map, which may be inconvenient. With different endstations possibly changing their respective happi databases and configurations, it would be good to give people the ability to check what their changes have done.

Throughout development / testing, I've used pygraphviz to create some facility graphs which were honestly... ugly.
Screen Shot 2022-07-27 at 3 50 03 PM
pygraphviz tries to keep each depth at the same level, which does not at all work for the facility graph.

This was something that was spitballed early on during the lightpath rework, but tabled.

Your Environment

lightpath master

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by examining the GUI entry points and LightController.graph, then review the existing BeamPath view and the facility graphs generated with pygraphviz. Define how the facility layout, branch expansion, and beam path should appear; done means users can inspect the facility layout and see the active path within lightpath.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data-visualization, frontend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.