Embed Size (px)
Citation preview
ESS Naming Convention
Karin Rathsman2013-03-04
Introduction
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
ESS Naming ConventionThe 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.
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)
Syntax
SSSS System Convention Name BBBB Subsystem Convention NameDDDD Device IdentifierIII Device QuantifierTTT Signal typeIII Signal instanceXXX Signal Suffix
SSSS-BBBB:DDDD-III:TTTIIIXXXDevice NameSignal Name
MotivationMillions 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.
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
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.
Devices
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.
… and this is also a device
This is a device...
Devices Inside Devices
HB-RF:Cav-1a
HB-RF:Cmd-1
HB-RF:Cav-1bHB-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 under the same system and subsystem
• The hierarchical structure are found in other systems where the names are used.
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
InventoryA 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.
Analysis of SNS Signal List
SNS Signal ListNS_Signallist.xlsx with 405647 signals names(SSSS_BBBB:DDDDIII:TTTIIIXXX)• 120 System names (SSSS)• 97 Subsystem names (BBBB)• 19350 Device identifiers & qualifiers
(DDDDIII)SNS Checklist.pdf• 40 System names • 135 Subsystem names • 634 Device identifiers
Analysis of SNS Signal ListSystem (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)
How to organise devices?
Device Category StructureExpect 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.
<Select><Select><Select>
Controls Ctrl ▶
Conventional Facilities CF ▶
Cryogenics Cryo ▶
Proton Beam Instrumentation PBI ▶
Proton Beam Optics PBO ▶
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 ▶
Slow Tuner STn ▶ Radio Frequency Quadrupole RFQ ▶
Power Coupler PCp ▶ Spoke Resonator Spk ▶
ETC ▶
ETC ▶
In Device Naming Tool Select device type:
Specific Type
Discipline
Generic Type
Device Identifier
Convention Name
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).
Area Breakdown StructureSystem 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.
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.
Target
In the Device Naming Tool<Select><Select> ← Select or type convention name← Select or type convention name← Select or type convention name← Select or type convention nameGallery ▶Accelerator ▶Target Station ▶ Active cells ActC ▶Instruments ▶ Active fluids ActF ▶Utilities ▶ Active handling ActH ▶Instruments ▶ Active workshops ActWS ▶
Handling mock-up HMU ▶Intermediate cooling systems Inm ▶Mobile active vacuum ActVM ▶Moderators-Reflector MR ▶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
Proton beam diagnostics skeleton PBDS
Internal supporting structure SpStr
Target diagnostics plug TDPlg
Target diagnostics skeleton TDS
Which part of the facility does the device provide service to?
Section
SubsectionSuper Section
Convention name
Convention name
Accelerator
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..
Nr Name SSSS1 Ion Source ISrc2 Low Energy Beam Transport LEBT3 Radio Frequency Quadrupole RFQ4 Medium Energy Beam Transport MEBT5 Drift Tube Linac DTL6 First Beam Extraction FBX7 Spoke Linac SPK8 Medium Beta MB9 Second Beam Extraction SBX10 High Beta HB11 Upgrade (or Upper) High Beta UHB12 High Energy Beam to Target HEBT13 High Energy Beam to Dump HEBD
FDSL_2012_New
352.21 MHz 704.42 MHz
2.4 m
LEBT
3.6 m
MEBT
? m
UHB
? m
SBX
? m
FBX
HEBD
159.8 m
HEBT
32.4 m
DTL
78 MeV
4.0 m
RFQ
3 MeV
ISRC
75 keV
58.5 m
SPK
200 MeV
227.9 m
HB
2500 MeV
113.9 m
MB
628 MeV
ESS Accelerator Sections
High Beta Subsections BLM
QV BPM
BBX
BCMHalo
BLM
BPM QH
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
QV BPMHalo
BBX
WS NPM
BLM
BPM QH
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
QV BPMHalo
BBX
WS NPM
BLM
BPM QH
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
QV BPM
BBX
WS NPM
BLM
BPM QH
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
QV BPM
BBX
WS NPM
BLM
BPM QH
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
QV BPM
BBX
BSM
BLM
BPM QH
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
QV BPM
BBX
BSM
BLM
BPM QH
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
QV BPM
BBX
BSM
BLM
BPM QH
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
QV BPM
BBX
Halo
BLM
BPM QH
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
QV BPM
BBX
BLM
BPM QH
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
QV BPM
BBX
BLM
BPM QH
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
QV BPM
BBX
BLM
BPM QH
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
QV BPM
BBX
BLM
BPM QH
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
QV BPM
BBX
BLM
BPM QH
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
QV BPM
BBX
BLM
BPM QH
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
BLM
GV
CMD
CAVH CAVH CAVH CAVHGV
HB-03! HB-04!HB-01! HB-02!
HB-07! HB-08!HB-05! HB-06!
HB-23! HB-24!HB-21! HB-22!
HB-15! HB-16!HB-13! HB-14!
HB-19! HB-20!HB-17! HB-18!
HB-11! HB-12!HB-09! HB-10!
HB-27! HB-28!HB-25! HB-26!
HB-29! HB-30!
In the Device Naming Tool
<Select><Select> ← Select or enter convention name← Select or enter convention name← Select or enter convention name← 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 ▶
Drift Tube Linac DTL ▶
First Beam Extraction FBX ▶
Spokes Section SPK ▶
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
6
Which part of the facility does the device provide service to?
Section
Subsection
Convention name
How to Construct Names?
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...
Accelerator and target namesConstruct 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.
Tools
General rules for namesName 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 numeric2. 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 4.
8. Leading zeros should be used to ensure that all numbers have the same number of digits.
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
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.
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.
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.
The End
”Those are my principles. If you don’t like them I have others.”
Groucho Marx
