SainsburyWellcomeCentre / aeon_experiments

Experiment workflows for Project Aeon
BSD 3-Clause "New" or "Revised" License
2 stars 0 forks source link

Proposal for include workflow subject naming conventions #431

Closed glopesdev closed 8 months ago

glopesdev commented 8 months ago

There is currently a large number of subjects created per device in experimental workflows which are hard to find and group together in the toolbox due to conflicting and contradictory naming conventions.

The proposal is to change the naming convention for subjects declared by include workflows which are repeated multiple times with unique instance names by adopting the same convention for device/stream names in the data contract. Specifically, unique device instance names are added as a "prefix" rather than a "suffix", e.g. PelletDeliveredPatch1 would change to Patch1PelletDelivered. This means that all subjects related to Patch1 would be immediately grouped and visible together in the toolbox.

In the future we will adopt a modular approach to data stream management which should help alleviate this issue but in the meantime this would help significantly with code organization.