DiamondLightSource/dodal

Replace use of BEAMLINE with INSTRUMENT

Open

#1.065 geöffnet am 20. Feb. 2025

Auf GitHub ansehen
 (1 Kommentar) (0 Reaktionen) (0 zugewiesene Personen)Python (12 Forks)auto 404
documentationhelp wantedlow priority

Repository-Metriken

Stars
 (4 Stars)
PR-Merge-Metriken
 (PR-Metriken ausstehend)

Beschreibung

As part of integrating with the super graph, groups need to standardise on names for commonly shared ideas (e.g. for LIMS a "session" is what DAQ call a "visit" is: so a compromise position of "instrument session" has been reached, meaning we can both write code that deals with "a specific allocated time slot on a specific allocated set of hardware" and it can interoperate.
An "instrument" is such a set of hardware: beamlines, microscopes, labs, etc. - we already have p38 (lab), p45-p49 (test rigs) and the adsim (simulated hardware) defined in dodal, and @dan-fernandes is looking to add the Optics lab to that number.

Proposals (not all equal in importance or urgency):

  • Rename get_beamline_name to get_instrument_name and allow it to read INSTRUMENT environment variable instead/as well
  • Rename the dodal.beamlines module to dodal.instruments (this would require a major version bump)
  • Rename the dodal.beamlines.beamline_utils module
  • Rename BeamlinePrefix
  • Move the code currently in dodal.beamlines.specific_beamline_utils into dodal.instruments.i03
  • Rename and modify the contents of create-beamline.rst
  • Find and replace other places beamline is used as a term in the generic, and add documentation explaining that dodal supports all forms of instrument of which beamlines are just one type

Acceptance Criteria

  • Specific criteria that will be used to judge if the issue is fixed

Contributor Guide