Add `storage_graph` to show the plugins stored or needed to be calculated in the dependency tree

dachengx commented 6 months ago

Before you submit this PR: make sure to put all operations-related information in a wiki-note, a PR should be about code and is publicly accessible

What does the code in this PR do / what does it improve?

Depends on https://github.com/XENONnT/base_environment/pull/1593

slack thread

As an example:

import straxen
st = straxen.contexts.demo()
test_run_id_1T = "180423_1021"
st.storage_graph(test_run_id_1T, "event_info", format="png")

gives you file 180423_1021-event_info.gv.png:

event_info gv

Can you briefly describe how it works?

green means already stored
orange means strax.SaveWhen.ALWAYS so that it will be saved if you process raw_records
yellow means strax.SaveWhen.TARGET
red means strax.SaveWhen.EXPLICIT
grey means strax.SaveWhen.NEVER

Can you give a minimal working example (or illustrate with a figure)?

Please include the following if applicable:

[ ] Update the docstring(s)
[ ] Update the documentation
[ ] Tests to check the (new) code is working as desired.
[ ] Does it solve one of the open issues on github?

Notes on testing

Until the automated tests pass, please mark the PR as a draft.
On the XENONnT fork we test with database access, on private forks there is no database access for security considerations.

All italic comments can be removed from this template.

coveralls commented 6 months ago

coverage: 91.298% (-0.02%) from 91.32% when pulling 4a003f12a8797734b6b31c2aa47e6ea45285145d on storage_graph into cd6ba20cd68a9836c32cd5baaa27aa5666d49825 on master.

dachengx commented 6 months ago

The failure of test is a comer case that might be fixed in another PR. https://github.com/XENONnT/straxen/actions/runs/8576757387/job/23508277771?pr=1353

XENONnT / straxen