WIP: mfx tree scratchpad #54

ZLLentz · 2024-10-02T23:11:00Z

Description

This is a draft PR intended for discussion rather than for merging.

As per #21 and https://jira.slac.stanford.edu/browse/BEAMS-6, this includes a realistic tree example that I used to get a feel for how much the existing structures were usable in a mid-sized close-to-real-world example.

This tree is intended to be part of a larger tree that would help MFX scientists set up their beamline. It would do the menial tasks like set slits to known values, put various devices in or out, and generally get the beamline ready to manually center the beam on the DG1 yag.

In the process, I made some prospective additions and changes to the tree_config submodule. These are all up for discussion and could be kept or discarded as appropriate: for example, perhaps it is more useful to adjust the existing resources rather than add these new resources?

Motivation and Context

We need to try this out on a sizeable real system and this gets us closer.

How Has This Been Tested?

Not at all, I was planning to make a caproto IOC or do some blackboard monkeypatching to play around with the logic in debug.

If any of the additions to tree_config are kept I can add the respective test cases.

Where Has This Been Documented?

Only here and in the jira ticket.

Pre-merge checklist

Code works interactively
Code follows the style guide
Code contains descriptive docstrings, including context and API
New/changed functions and methods are covered in the test suite where possible
Test suite passes locally
Test suite passes on GitHub Actions
Ran docs/pre-release-notes.sh and created a pre-release documentation page
Pre-release docs include context, functional descriptions, and contributors as appropriate

ZLLentz · 2024-10-02T23:15:19Z

Some follow-up tasks for me here:

Check what the serialized tree looks like
Build a sim IOC or implement the blackboard thing

ZLLentz · 2024-10-03T20:57:29Z

Attaching SVG render of the tree courtesy of py_trees

In [1]: from mfx_tree import dg1_prep

In [2]: tree = dg1_prep.get_tree()

In [3]: from py_trees.display import render_dot_tree

In [4]: render_dot_tree(tree)
Writing /cds/home/z/zlentz/github/beams/dg1_prep.dot
Writing /cds/home/z/zlentz/github/beams/dg1_prep.png
Writing /cds/home/z/zlentz/github/beams/dg1_prep.svg
Out[4]:
{'dot': '/cds/home/z/zlentz/github/beams/dg1_prep.dot',
 'png': '/cds/home/z/zlentz/github/beams/dg1_prep.png',
 'svg': '/cds/home/z/zlentz/github/beams/dg1_prep.svg'}

…t be there

ZLLentz · 2024-10-16T21:01:26Z

beams/tree_config.py

@@ -35,6 +36,15 @@ def get_tree_from_path(path: Path) -> py_trees.trees.BehaviourTree:
    return tree_item.get_tree()


+def save_tree_to_path(path: Union[Path, str], root: BaseItem):


ZLLentz · 2024-10-16T21:01:52Z

beams/bin/gen_test_ioc_main.py

keep, consider separating to own tool, consider extending to read control system and spoof pvs exactly

Split off to #57

ZLLentz · 2024-10-16T21:04:49Z

beams/tree_config.py

@@ -155,24 +169,96 @@ def cond_func():
        return cond_func


+@dataclass
+class SequenceConditionItem(BaseItem):


keep, might need changes with other pr

ZLLentz · 2024-10-16T21:09:19Z

beams/tree_config.py

+
+
+@dataclass
+class RangeConditionItem(BaseItem):


Add, consider alternate implementations (operator or functional on top of ConditionItem) and review

ZLLentz · 2024-10-16T21:12:48Z

beams/tree_config.py

@@ -236,18 +322,38 @@ def work_func(comp_condition: Callable[[], bool]) -> py_trees.common.Status:

 @dataclass
 class CheckAndDoItem(BaseItem):


Submit as own PR, discuss later

ZLLentz · 2024-10-16T21:16:16Z

beams/tree_config.py

+AnyConditionItem = Union[ConditionItem, SequenceConditionItem, RangeConditionItem, UseCheckConditionItem]
+AnySequenceItem = Union[SequenceItem, SequenceConditionItem]


Keep, document interface

ZLLentz · 2024-10-16T21:17:50Z

mfx_sim.py

start examples folder???

ENH: add test ioc generator from #54

ENH: include save_tree_to_path from #54

ENH: implement SequenceConditionItem from #54

ZLLentz · 2024-11-04T22:49:56Z

All composite PRs from this one are merged
But I will need to create one final PR to include the mfx tree as an example

I think I'll also wait on a potential impending comparisons rework to handle the range and/or isclose case

ZLLentz · 2024-11-08T18:28:18Z

It is now time to make the mfx tree examples PR!
Once that PR is up I will close this one

ZLLentz · 2024-11-08T18:36:23Z

Closing now that #68 exists

ZLLentz added 5 commits October 1, 2024 17:18

WIP: start mfx tree sketch and various tweaks to tree config

f72ad1f

WIP: try unions instead of protocols for simplicity

81e6bca

WIP: build out most of the rest of the dg1 part of the mfx tree

e77777d

STY: pre-commit run --all-files

e081a0d

WIP: add a full sequence for this subtree

cf4457f

ZLLentz added 4 commits October 3, 2024 11:43

ENH: add helper for serializing a tree to a file

bbe002d

BLD: check what the mfx json file would look like

28c679e

ENH: reduce duplication of data in serialized check and do

1f7c07a

FIX: probably this was breaking the test suite

737deee

ZLLentz added 7 commits October 3, 2024 14:54

FIX: wayward comma leads to lists of bools

8a14afc

ENH: quick script for generating test IOCs, apply to MFX tree

5ed5517

ENH: set initial values and fix base pv error in mfx tree

b291e3a

FIX: typo, used pfl cads again in tfs

99778b9

ENH: generate json and IOC with previous missing tfs

784d0ed

MNT: skip termination check debug statement, assumes pv but pv may no…

4a48685

…t be there

ENH: pick a different port for testing

ed6f3bf

ZLLentz commented Oct 16, 2024

View reviewed changes

mfx_sim.py

Copy link

Member Author

ZLLentz Oct 16, 2024

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

start examples folder???

ZLLentz added a commit to ZLLentz/BEAMS that referenced this pull request Oct 17, 2024

ENH: add test ioc generator from pcdshub#54

1e098cc

ZLLentz mentioned this pull request Oct 17, 2024

ENH: add test ioc generator from #54 #57

Merged

11 tasks

ZLLentz added a commit to ZLLentz/BEAMS that referenced this pull request Oct 17, 2024

ENH: include save_tree_to_path from pcdshub#54

a3f54e8

ZLLentz added a commit to ZLLentz/BEAMS that referenced this pull request Oct 17, 2024

ENH: implement SequenceConditionItem from pcdshub#54

c6b49e2

ZLLentz added a commit to ZLLentz/BEAMS that referenced this pull request Oct 17, 2024

ENH: add RangeConditionItem from pcdshub#54 (needs revisions)

a00b814

ZLLentz mentioned this pull request Oct 17, 2024

ENH: add RangeConditionItem from #54 #60

Closed

8 tasks

ZLLentz added a commit that referenced this pull request Oct 18, 2024

Merge pull request #57 from ZLLentz/enh_test_ioc_gen

5399d48

ENH: add test ioc generator from #54

ZLLentz added a commit that referenced this pull request Oct 18, 2024

Merge pull request #58 from ZLLentz/enh_add_serialize_helper

328e716

ENH: include save_tree_to_path from #54

ZLLentz added a commit that referenced this pull request Nov 4, 2024

Merge pull request #59 from ZLLentz/enh_seq_cond_item

68012b7

ENH: implement SequenceConditionItem from #54

ZLLentz closed this Nov 8, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

WIP: mfx tree scratchpad #54

WIP: mfx tree scratchpad #54

ZLLentz commented Oct 2, 2024 •

edited

Loading

ZLLentz commented Oct 2, 2024

ZLLentz commented Oct 3, 2024

ZLLentz Oct 16, 2024

ZLLentz Oct 16, 2024

ZLLentz Oct 17, 2024

ZLLentz Oct 16, 2024

ZLLentz Oct 16, 2024

ZLLentz Oct 16, 2024

ZLLentz Oct 16, 2024

ZLLentz Oct 16, 2024

ZLLentz commented Nov 4, 2024 •

edited

Loading

ZLLentz commented Nov 8, 2024

ZLLentz commented Nov 8, 2024

		@@ -35,6 +36,15 @@ def get_tree_from_path(path: Path) -> py_trees.trees.BehaviourTree:
		return tree_item.get_tree()


		def save_tree_to_path(path: Union[Path, str], root: BaseItem):

		@@ -236,18 +322,38 @@ def work_func(comp_condition: Callable[[], bool]) -> py_trees.common.Status:

		@dataclass
		class CheckAndDoItem(BaseItem):

		AnyConditionItem = Union[ConditionItem, SequenceConditionItem, RangeConditionItem, UseCheckConditionItem]
		AnySequenceItem = Union[SequenceItem, SequenceConditionItem]

WIP: mfx tree scratchpad #54

WIP: mfx tree scratchpad #54

Conversation

ZLLentz commented Oct 2, 2024 • edited Loading

Description

Motivation and Context

How Has This Been Tested?

Where Has This Been Documented?

Pre-merge checklist

ZLLentz commented Oct 2, 2024

ZLLentz commented Oct 3, 2024

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

ZLLentz commented Nov 4, 2024 • edited Loading

ZLLentz commented Nov 8, 2024

ZLLentz commented Nov 8, 2024

ZLLentz commented Oct 2, 2024 •

edited

Loading

ZLLentz commented Nov 4, 2024 •

edited

Loading