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 - Collect requirements from stakeholders - Name support - Enforce syntax - Assure unique names

8 Guidelines Names shall be short, yet meaningful and organised consistently. Name structure does not need to 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 Devices are not organised hierarchically through the naming convention. Example: There are four cavities inside a cryomodule. Both cryomodule and cavities are devices under the same system and subsystem The hierarchical structure are found in other systems where the names are used. HB-RF:Cmd-1 HB-RF:Cav-1a HB-RF:Cav-1b HB-RF:Cav-1c HB-RF:Cav-1d

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-1d

14 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. 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. The other way around, given the inventory ID it shall be possible to look up the device name.

15 Analysis of SNS Signal List

16 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

17 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)

18 How to organise devices?

19 Device Category Structure Expect hundred thousands different devices. In the naming tool the devices types shall be sorted under Level 1: Discipline - RF - Vacuum - Water cooling Level 2: Generic Device Type - Two devices of the same generic type provide the same function - Example: RF cavities accelerates the beam. Level 3: Specific Device Type - Two devices of the same specific type are identical from a controls perspective and have the same set of control signals. - Example: Elliptical cavities.

20 Select device type: In Device Naming Tool <Select> Controls Ctrl Conventional Facilities CF Discipline Cryogenics Cryo Proton Beam Instrumentation PBI Proton Beam Optics PBO Generic Type Specific Type Super Conducting RF RF Cavity Cav Buncher Cavity BCav Vacuum Vac Cryomodule CMd DTL tank DTnk Water Cooling WtrC Fast Tuner FTn Elliptical Cavity ECav Convention Name Slow Tuner STn Radio Frequency Quadrupole RFQ Power Coupler PCp Spoke Resonator Spk ETC ETC Device Identifier

21 Device Identifier DDDD Both accelerator and target groups prefer to use generic device identifier DDDD in the names. Device names shall be constructed using the generic device identifier (Level 2). However: Users are responsible for selecting the right specific device type. (Level 3).

22 Area Breakdown Structure 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. Rather, Ask explicitly: Which part of the facility does the device provide services to? - Do NOT ask: Where is the device located? The answer shall be selected from a list.

23 Target

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

25 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 Section Handling mock-up HMU Intermediate cooling systems Inm Mobile active vacuum ActVM Moderators-Reflector MR Subsection 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 Section Convention name Proton beam diagnostics skeleton PBDS Internal supporting structure SpStr Target diagnostics plug TDPlg Target diagnostics skeleton TDS

26 Accelerator

27 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..

28 FDSL_2012_New ESS Accelerator Sections Nr 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

29 High Beta Subsections BBX HB-01! HB-02! BBX HB-03! HB-04! QV BPM BCMHalo BPM QH BBX HB-05! HB-06! QV BPMHalo WS NPM BPM BBX QH HB-07! HB-08! QV BPMHalo WS NPM BPM BBX QH HB-09! HB-10! QV BPM WS NPM BPM BBX QH HB-11! HB-12! QV BPM WS NPM BPM BBX QH HB-13! HB-14! QV BPM BSM BBX BPM QH HB-15! HB-16! QV BPM BSM BBX BPM QH HB-17! HB-18! QV BPM BSM BBX BPM QH HB-19! HB-20! QV BPM Halo BBX BPM QH HB-21! HB-22! QV BPM BBX BPM QH HB-23! HB-24! QV BPM BBX BPM QH HB-25! HB-26! QV BPM BBX BPM QH HB-27! HB-28! QV BPM BBX BPM QH HB-29! HB-30! QV BPM BPM QH QV BPM BPM QH

30 In the Device Naming Tool Which part of the facility does the device provide service to? <Select> Select or enter convention name Gallery Accelerator Ion Source ISrc Target Station Low Energy Beam Transport LEBT Instruments Radio Frequency Quadrupole RFQ Utilities Medium Energy Beam Transport MEBT Subsection Drift Tube Linac DTL First Beam Extraction FBX Spokes Section SPK Section 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 Convention name 5 6

31 How to Construct Names?

32 Structure and Syntax Syntax: SSSS-BBBB:DDDD-III The Device Category Structure (Discipline - Generic Device Type - Specific Device Type) and the area breakdown structure ( Super section - Section - Subsection) contain enough information to construct the device names. However...

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

34 Tools

35 General rules for names Name here refers to convention names for section, subsections, discipline as well as generic and specific device identifiers. 1. Names, quantifier and signal part of name shall be alphanumerical. 2. First character of Names, excluding subsection convention name of accelerator sections, shall be alphabetic. 3. For accelerator sections: 1. Subsection convention name shall be numeric 2. First character of quantifier shall be alphabetic 4. Names except subsection convention names and generic device identifiers 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. Subsection convention names shall be unique according to rule 4, however only within each section. 6. Generic device identifiers shall be unique according to rule 4, however only within each discipline. 7. Device name (SSSS-BBBB:DDDD-III) and signal names shall be unique according to rule Leading zeros should be used to ensure that all numbers have the same number of digits.

36 Device Naming Tool User: System owner Access: TBD Shall be possible to select subsystem from the section menu. The terms Section or Subsection 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 generic and specific device from the device category structure. The term Discipline or Generic/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 subsection

37 Device Category Menu Tool User: NamingTzar Access: TBD Shall be possible to add/delete/edit - Discipline (full name and convention name) - Generic device types - Specific device types Version control Tool shall check the convention names according to the general rules for names. Disciplines and Device Types shall be alphanumerical ordered.

38 Area Breakdown Menu Tool User: NamingTzar Access: TBD Shall be possible to add/delete/edit: - Super section names ( full name) - Section names (full name and convention name) - Subsection 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.

39 Other Tools (later) 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.

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