ESS Naming Convention - Lunds Naming Convention 20آ  ESS Naming Convention The ESS Naming Convention

  • View

  • Download

Embed Size (px)

Text of ESS Naming Convention - Lunds Naming Convention 20آ  ESS Naming Convention The ESS Naming...

  • ESS Naming Convention

    Karin Rathsman 2013-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 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.

  • 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 Name DDDD Device Identifier III Device Quantifier TTT Signal type III Signal instance XXX Signal Suffix

    SSSS-BBBB:DDDD-III:TTTIIIXXX Device Name Signal Name

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

  • 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-1b HB-RF:Cav-1c


    • 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







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

  • Analysis of SNS Signal List

  • SNS Signal List NS_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 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)

  • How to organise devices?

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

  • 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


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

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


  • In the Device Naming Tool ← Select or type convention name← Select or type convention name← Select or type convention name← Select or type convention name Gallery ▶ 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?


    Subsection Super 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