scipp / scipp/ess

Should horizontal graphs created with `visualize` be the default?

Open
#145 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

essreduce
Dominant language
Python
Stars
1
Forks
3
Avg merge
2d 11h
Merged PRs (30d)
17

Description

We seem to use graph_attr={'rankdir': 'LR'} in all our workflows. Should this just be the default behaviour of visualize?

In the sciline docs, we seem to mostly use vertical graphs, which makes sense with the page layout (and the graphs tend to be relatively short).
Would be a little annoying (confusing?) to have to use graph_attr={'rankdir': 'TB'} in the docs, but I feel the UX gain for reduction workflows would be worth it?

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 reviewing the visualize entry point and the existing graph_attr={'rankdir': 'LR'} usages in workflows, then compare them with the vertical graphs in the sciline docs. Done requires a decided default direction and corresponding workflow and documentation behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
data-visualization
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.