IBEX device generator: Make it lightweight and working

ISISComputingGroup / IBEX

IBEX device generator: Make it lightweight and working #8366

Closed zsoltkebel closed 2 weeks ago

zsoltkebel commented 1 month ago

As a developer I would like the device generator script to be reliable and lightwieght.

The aim of this work is to implement the simple concept of device generation with reliable branch switching and committing. The script should not try to solve dirty git repo states.

Questions:

~Do we need to call the pearl scripts to make support and IOC structures or can we have a template and use that directly in python?~ Ansered - It is ok to not use the pearl scripts

For reviewer

[x] Update IOC creation wiki page (https://github.com/ISISComputingGroup/ibex_developers_manual/wiki/IOCs) to link to new device generator repo for automation.
[x] Mark the old device generator repo (https://github.com/ISISComputingGroup/IBEX_device_generator) deprecated.

zsoltkebel commented 3 weeks ago

The new Device generator:

https://github.com/ISISComputingGroup/IBEX-device-generator

There is no need to merge this as this is a new repository.

Test

Test by trying to create a new device with the script. __Make sure the three repos EPICS, ibex_gui, and EPICS/ioc/master are on latest master and submodules are updated beforehand.__

Only PR in release notes:

https://github.com/ISISComputingGroup/IBEX/pull/8380

rerpha commented 3 weeks ago

reviewer should probs archive https://github.com/ISISComputingGroup/IBEX_device_generator (the old one)

LowriJenkins commented 2 weeks ago

One minor change suggestion, but otherwise looks good on the code front, I've used the device generator (stress tested it under weird circumstances even) for the DDS Stress-rig, so I'm happy to say this is working.

Device Info still defaults to 1 and says as much in the comments, this is a minor thing since having a default argument higher up will over-rule this, but it could be a little confusing so probably for the best for it to be changed.
Might be worth adding pip installing this to the developer version of genie python? maybe woth a friday ticket.

LowriJenkins commented 2 weeks ago

https://github.com/ISISComputingGroup/ibex_developers_manual/wiki/IOC-Generator The old device generator had a wiki page detailing how it worked (as well as linking to the readme for instructions) we should either update this with explanations of the new device generator, or delete it.

zsoltkebel commented 2 weeks ago

Default device count inconsistency addressed here: https://github.com/ISISComputingGroup/IBEX-device-generator/commit/218257d80950beffc8d3f26c66164aded5449710. Made it a class variable and reference elsewhere.

I will add some more in the README about how the templating works but I hope the code and comments are clear enough anyways.

zsoltkebel commented 2 weeks ago

Added contributing guidelines here: https://github.com/ISISComputingGroup/IBEX-device-generator/blob/main/CONTRIBUTING.md These include development workflow and making a new release.