ESS Naming Convention

Transcription

1 ESS Naming Convention Karin Rathsman

2 Introduction

3 ESS Naming Convention The ESS Naming Convention apply to all devices and signals in technical systems and conventional facilities. operator screens inventory system drawings design schematics computer software project databases equipment name tags test procedures other sources of technical information at ESS. ESS Naming Convention Naming Convention Revision: 1.2 Status: Accepted Project: ESS Naming Convention Document ID: ESS/AD/0005 File: ESS Naming Convention.doc Owner: Garry Trahern Last modification: Maay 17, 2011 Created: October 26, 2010

4 History ESS Naming Convention is based on a standard developed for the Super Superconducting Collider (SSC) and later adopted to other large research facilities: Spallation Neutron Source (SNS) Facility for Rare Isotope Beams (FRIB) International Thermonuclear Experimental Reactor (ITER) Continuous Electron Beam Accelerator Facility (CEBAF)

5 Syntax SSSS-BBBB:DDDD-III:TTTIIIXXX Device Name Signal Name SSSS BBBB DDDD III TTT III XXX System Convention Name Subsystem Convention Name Device Identifier Device Quantifier Signal type Signal instance Signal Suffix

6 Motivation Millions of signals to control and thousands of devices to operate: Short, meaningful and structured names needed for communication and configuration. Can t rely on high level industrial HMI (barcodes, touch screens, etc.) to operate the facility. Industry standards for naming not applicable - Not human readable. - One of the kind facility. A uniform naming convention for ESS will help enforce system integration activities across all divisions.

7 Act Proactively Establish a naming convention at an early stage of the project. Assign a Naming Czar - Assure consistency - Coordinate - Update the naming convention document on implementation details. Communicate, communicate and communicate... - Accelerator, - Target, - Neutron instruments, - Conventional Facilities, - etc. Develop a naming tool - Name support - Enforce syntax - Assure unique names

8 Guidelines Names shall be short, yet meaningful and organised consistently. Name structure does not need follow WBS or other project management structures. - These are for optimising design and construction. - Device names can however be used to name equipment in these structures. Databases integration is vital.

9 Devices

10 Definition From the ICS point of view, all equipment is modeled as devices. Device is an abstraction that can represent either single pieces of equipment (low level code for interfacing with the hardware)......or higher-level entities of the ICS ( e.g., device models, subsystems, instruments...) Device is the basic unit of granularity of the ICS the smallest that can still be standalone and loosely coupled to other components.

11 This is a device... and this is also a device

12 Devices Inside Devices CMD HB#RF:Cmd#1+ HB#RF:Cav#1a+ HB#RF:Cav#1b+ HB#RF:Cav#1c+ HB#RF:Cav#1d+ Devices are not organised hierarchically through the naming convention. Example: There are four cavities inside a cryomodule. Both cryomodule and cavities are devices. CMD The hierarchical structure are found in other systems where the names are used. QH

13 Parent/Child Structure HB-1 HB-RF:Cmd-1 HB-RF:Cav-1a HB-RF:Cav-1b HB-RF:Cav-1c HB-RF:Cav-1c

14 Analysis of SNS Signal List

15 SNS Signal List NS_Signallist.xlsx with signals names (SSSS_BBBB:DDDDIII:TTTIIIXXX) 120 System names (SSSS) 97 Subsystem names (BBBB) Device identifiers & qualifiers (DDDDIII) SNS Checklist.pdf 40 System names 135 Subsystem names 634 Device identifiers

16 Analysis of SNS Signal List System (SSSS) approximately shows the part of the facility that the device provide services to. HEBT (High Energy Beam Transport) SCL (Super Conducting Linac) Tgt (Target) SubSystem (BBBB) approximately shows in what context (or discipline) the device is used Diag (Beam Diagnostics) Vac (Vaccum) LLRF (Low Level RF)

17 How to organise devices?

18 Inventory A device name SSSS-BBBB:DDDD-III depends on where the device it is installed and its function. As such it is not an inventory ID, since when a device is replaced, the new device inherits the name. Nevertheless, given the name of a device it shall be possible to look it up in the inventory system and the other way around given the inventory ID, it shall be possible to look up the device name. Therefore it is necessary to link device names to inventory IDs. The inventory in BLED will contain useful information for constructing the device names, such as discipline and generic device type identifiers.

19 Organising Devices Expect hundred thousands different devices. Devices in an inventory shall be sorted under Level 1: Discipline - RF - Vacuum - Water cooling Level 2: Generic Device Type - RF cavities - High power amplifiers - Valves Level 3: Control Device Type - Elliptical Cavities - Spoke cavities Level 4: Specific Device Type - High Beta Elliptical Cavities - Medium Beta Cavities Do not use the term Discipline or Generic/Control/Specific in the Device Naming Tool Rather instruct: Select Device

20 Definition of device types Generic Type: Two devices of the same generic type provide the same function Example: RF cavities accelerates the beam. Control Type: Two devices of the same control type are identical from a controls perspective and have the same set of control signals. Example: Elliptical cavities are controlled the same way. Specific Type: Two devices of the same specific type are interchangeable. I.e., if one device breaks it can be replace by another device of the same specific type. Example: High beta elliptical cavities are interchangeable.

21 Select device: <Select> Controls Ctrl In Device Naming Tool Conventional Facilities CF Discipline Cryogenics Cryo Proton Beam Instrumentation PBI Proton Beam Optics PBO Generic Type Radio Frequency RF Accelerating structure Control Type Cav Buncher Cavity BCav Specific Type Inventory ID Vacuum Vac Cryomodule CMd DTL tank DTnk Water Cooling WtrC Convention Name High Power Amplifier Low Power Amplifier PCp Elliptical Cavity ECav Radio Frequency Quadrupole ETC Spoke Resonator RFQ Spk High Beta Cavity Low Beta cavity HBC LBC AcDFQR1 ADFv3a55 caqgera ETC asfz Device Identifier ETC y

22 Device Naming Tool For the present There are only generic device types in the naming lists. The device naming tool is too complicated. Therefore, plan for the final version but start with generic types only. At a later stage add: Control type Specific type Inventory ID

23 Select device type: In Device Naming Tool (initial version) <Select> Select or type DDDD Controls Ctrl Conventional Facilities CF Discipline Cryogenics Cryo Proton Beam Instrumentation PBI Proton Beam Optics PBO Generic Type Device Identifier Radio Frequency RF Accelerating structure Cav Vacuum Vac Cryomodule CMd Water Cooling WtrC Convention Name High Power Amplifier Low Power Amplifier ETC ETC ETC HPA

24 Device Identifier DDDD Both accelerator and target groups prefer to use generic device identifier DDDD in the names. Until decided differently: Device names shall be constructed using the generic device identifier.

25 Systems System SSSS in the ESS naming convention indicates which part of the facility that the device provide services to. Name and label ESS zones/sections after the systems. Do not use the term System in the Device Naming Tool. Ask explicitly: Which part of the facility does the device provide services to? The answer shall be selected from a list.

26 Target

27 Target Target has few devices compared to accelerator, however many things are unique. Target already has a PBS organized in two levels. - Referred to as System-Subsystem by the target group. Devices like pumps, valves etc., appear in many subsystems. There is no desire to use discipline in the name.

28 In the Device Naming Tool Which part of the facility does the device provide service to? <Select> Select or type convention name Gallery Accelerator Target Station Active cells ActC Instruments Active fluids ActF Utilities Active handling ActH Instruments Active workshops ActWS Convention name Super System Handling mock-up HMU Intermediate cooling systems Inm Mobile active vacuum ActVM Moderators-Reflector MR Subsystem Monolith Mnlt Shielding cooling system ShCol Proton beam window PBW Monolith atmosphere system Atm RGEC RGEC Bulk shielding BlkSh Shielding TSh Irradiation plugs IrPlg Target Tgt Liner Lin Target safety system TSS Removable shielding RvSh TS storage TSg Shutter systems Shut Tune-up dump TDmp Neutron beam ports (NBP) NBP Proton beam diagnostics plug PBDPlg System Convention name Proton beam diagnostics skeleton PBDS Internal supporting structure SpStr Target diagnostics plug TDPlg Target diagnostics skeleton TDS

29 Accelerator

30 Accelerator There are many devices of the same kind in the accelerator in a repetitive pattern. The accelerator is divided into sections - Example High beta (HB) Sections are in turn is divided into numbered subsections - Example HB 1, HB 2, HB 32. Each subsection contains many devices of different disciplines. - RF, vacuum, Beam optics, etc..

31 FDSL_2012_New ESS Accelerator Sections ID Name SSSS 1 Ion Source ISrc 2 Low Energy Beam Transport LEBT 3 Radio Frequency Quadrupole RFQ 4 Medium Energy Beam Transport MEBT 5 Drift Tube Linac DTL 6 First Beam Extraction FBX 7 Spoke Linac SPK 8 Medium Beta MB 9 Second Beam Extraction SBX 10 High Beta HB 11 Upgrade (or Upper) High Beta UHB 12 High Energy Beam to Target HEBT 13 High Energy Beam to Dump HEBD 2.4 m 4.0 m 3.6 m 32.4 m? m 58.5 m m? m m? m m ISRC LEBT RFQ MEBT DTL FBX SPK MB SBX HB UHB HEBT 75 kev 3 MeV 78 MeV 200 MeV 628 MeV 2500 MeV HEBD

32 High Beta Subsections BBX CMD HB 1! CMD HB 2! BBX CMD HB 3! CMD HB 4! QV BPM BCMHalo BPM QH BBX QV CMD HB 5! CMD HB 6! BPMHalo WS NPM BPM BBX QH CMD HB 7! CMD HB 8! QV BPMHalo WS NPM BPM BBX QH CMD HB 9! CMD HB 10! QV BPM WS NPM BPM BBX QH CMD HB 11! CMDHB 12! QV BPM WS NPM BPM BBX QH CMD HB 13! CMD HB 14! QV BPM BSM BBX BPM QH CMD HB 15! CMDHB 16! QV BPM BSM BBX BPM QH CMD HB 17! CMD HB 18! QV BPM BSM BBX BPM QH CMD HB 19! CMDHB 20! QV BPM Halo BBX BPM QH CMD HB 21! CMD HB 22! QV BPM BBX BPM QH CMD HB 23! CMDHB 24! QV BPM BBX BPM QH CMD HB 25! CMD HB 26! QV BPM BBX BPM QH CMD HB 27! CMDHB 28! QV BPM BBX BPM QH CMD HB 29! CMD HB 30! QV BPM BPM QH QV BPM BPM QH

33 In the Device Naming Tool Which part of the facility does the device provide service to? <Select> Gallery Select or enter convention name Accelerator Ion Source ISrc Target Station Low Energy Beam Transport LEBT Instruments Radio Frequency Quadrupole RFQ Utilities Medium Energy Beam Transport MEBT Subsystem Drift Tube Linac DTL First Beam Extraction FBX Spokes Section SPK System Medium Beta Elliptical Cavities MB High Beta Elliptical Cavities HB 1 Upgrade (or Upper) High Beta UHB 2 High Energy Beam transport to Target HEBT 3 High Energy Beam transport to Dump HEBD 4 5 Convention name 6

34 How to Construct Names?

35 Structure and Syntax Syntax: SSSS-BBBB:DDDD-III The inventory (Discipline - Device) and the system breakdown structure ( System - Subsystem) contain enough information to construct the device names. However...

36 First Attempt Let SSSS = system convention name BBBB = the subsystem convention name. Outcome: Ok for target Accelerator device names like HB-3:Cav-2 not accepted. Shall be HB-RF:Cav-3b.

37 Second Attempt Let SSSS = subsystem convention name. BBBB = discipline convention name. Outcome: Not accepted by target. Accelerator device names like HB3-RF:Cav-2 not accepted. Shall be HB-RF:Cav-3b.

38 Third Attempt Let SSSS = system convention name BBBB = discipline convention name. Outcome: Not accepted by target Accelerator device names like HB-RF:Cav-3b accepted.

39 Forth Attempt Let SSSS = the system convention name BBBB = subsystem convention name, however the accelerator subsystems are given by the discipline instead of the subsection numbers Outcome: Accepted by target Accepted by accelerator Not accepted by naming tzar because the structure is wrong: - Disciplines applies to all the accelerator sections and shall not be sorted under these. - No device categorisation

40 Latest Attempt Construct accelerator and target names differently. Target - SSSS = System Convention Name - BBBB = Subsystem Convention Name - III = Whatever... Accelerator - SSSS = System Convention Name - BBBB = Discipline Convention Name - First part of qualifier III = Subsystem ( a number) - Second part of qualifier III = a, b, c, d or whatever starts with an alphabetic character.

41 Conclusion The System-Subsystem and Discipline- Device type tables contain sufficient information for naming accelerator and target devices, however the names need to be constructed differently. Not a surprise since accelerator and target are very different. If we manage to consistently name devices for both target and accelerator it should be straightforward to name other devices at ESS.

42 Tools

43 Device Naming Tool User: System owner Access: TBD Shall be possible to select subsystem from the system menu. The terms System or Subsystem shall not be be displayed in the tool. Rather ask Which part of the facility does the device provide services to? Shall be possible to select discipline and device from inventory. The term Discipline or Generic/Control/Specific shall not be be displayed in the tool. Rather instruct: Select Device. Shall be possible to add/edit/remove quantifier. Tool shall check Device Names according to the general rules for names. Shall be possible to customize order of devices within one subsystem

44 General rules for names Name here refers to convention names for system, subsystem, discipline as well as device identifiers. 1. Names, quantifier and signal part of name shall be alphanumerical. 2. First character of Names, excluding subsystem convention name of accelerator systems, shall be alphabetic. 3. For accelerator systems: 1. Subsystem convention name shall be numeric 2. First character of quantifier shall be alphabetic 4. Names shall be unique irrespective of: 1. Letter case; 2. Letters I, l and number 1; 3. Letter O and number 0; 4. Letters V and W; 5. Number 0 immediately following a non-numerical character 5. Device name (SSSS-BBBB:DDDD-III) and signal names shall be unique according to rule 4.

45 Device Menu Tool User: Naming Tzar Access: TBD Shall be possible to add/delete/edit - Discipline (full name and convention name) - Device types (three levels with full name and identifier) - Inventory ID Version control Tool shall check the convention names according to the general rules for names. Disciplines, Device Types and inventory ID shall be alphanumerical ordered.

46 System Menu Tool User: naming Tzar Access: TBD Shall be possible to add/delete/edit: - Super system names ( full name) - System names (full name and convention name) - Subsystem names (full name and convention name) Version control Tool shall check the convention names according to the general rules for names. Shall be possible to customize order of names in menus.

47 Signal Tool (final version) User: Configurator. Access: TBD For a selected generic device type it shall be possible to add/remove/edit - control types (full name and identifier) For a given device identifier of control type it shall be possible to add/remove/edit - Signals (TTTIIIXXX) Version control Tool shall check the convention names and signal part of names according to the general rules for names.

48 Other Tools Viewer: Given any device name SSSS-BBBB:DDDD-III it shall be possible to find all relevant information about this device. Given any signal name SSSS-BBBB:DDDD-III:TTTIIIXXX it shall be possible to find all relevant information about this signal. Given any part of the name (SSSS, BBBB, DDDD, III, TTT, III or XXX) it shall be possible to find the relevant information. Listing tools: Shall be possible to export name lists to e.g. excel spread sheets. Shall be possible to filter system, subsystem, context, device types.

49 Those are my principles. If you don t like them I have others. Groucho Marx The End