Documentation Chris Scanlon and Ritendra Bhattacharya LCLS-II Software Review November 14, 2018

Charge 1. GENERAL a. Is the documentation and coding maturity consistent with the schedule? 2. EQUIPMENT PROTECTION a. Are all equipment protection functions (in particular responses to abnormal conditions such as trips, alarms and interlocks) comprehensive, clearly identified, documented, implemented and traceable to the PLC code? 3. DEFINITION AND DOCUMENTATION a. Are all automated functions (Alarms, Trips, Interlocks / Permissive, Cause and Effects, Control Loops, and Automated Sequences) sufficiently documented for Coding, Testing, Commissioning, Operation and Troubleshooting? b. Is there traceability between documentation and the PLC code? 4. CODING a. Are coding rules adequately defined and implemented? b. Is the PLC code clearly developed, and consistent with documentation and coding rules? 5. BENCH TESTING a. Has JLAB developed an appropriate plan for testing the CRYOPLANT control systems? b. Is the EPICS HMI testing integrated with the PLC tests? LCLS-II Software Review, November 14, 2018

Outline Documentation Package P&IDs FMEAs Functional Narratives Software Specifications PLC Software Traceability Test Plan Test Report LCLS-II Software Review, November 14, 2018

Documentation Package P&IDs Wiring diagrams FMEAs Functional narratives Software specifications Software testing procedure Software testing form PLC software LCLS-II Software Review, November 14, 2018

P&IDs P&IDs – Piping and Instrumentation Diagrams These diagrams show the process piping and instruments in that piping. The P&IDs are developed by a process engineer/plant designer. These show the control engineer on what needs to be connected to the control system. From these, the control engineer can develop the wiring diagrams for the control system. The LCLS-II P&IDs and wiring diagrams started with those existing for systems at JLab. LCLS-II Software Review, November 14, 2018

FMEAs Failure Mode and Effects Analyses These documents look at each element in a system and analyze the possible failure modes and the result on the system of those failure modes. This analysis informs the process engineer of any situations which should be mitigated against. Mitigation of failure modes can come in many forms, such as a process design change, operational procedure, alarm, trip, interlock, automated system reaction LCLS-II Software Review, November 14, 2018

Functional Narratives The functional narratives are developed by a process engineer. They describe how the process flows and how to operate the system. The LCLS-II functional narratives are based on how JLab operates the CHL refrigerator systems. LCLS-II Software Review, November 14, 2018

Software Specifications The software specification is written using the information provided by the P&IDs, functional narratives and FMEAs. The software specifications include all of the I/O points in the system, alarms, trips, interlocks, PID loops and any other types of automation required for operation. The general software specification lays out the general formatting and rules for the software. The LCLS-II software specifications were based on the software running systems at JLab. Air Liquide provided the 4K cold box software specification, which they call the control philosophy. LCLS-II Software Review, November 14, 2018

Software Specifications All I/O points in the system A sample from the Gas Management Software Specification 79120-C6002 alarms trips interlocks PID loops any other types of automation required for operation. LCLS-II Software Review, November 14, 2018

Software Specifications Alarms: A sample from the Gas Management Software Specification 79120-C6002 Trips: A sample from the 2K Cold Box Software Specification 79222-C6001 LCLS-II Software Review, November 14, 2018

Software Specifications Interlocks: A sample from the 2K Cold Box Software Specification 79222-C6001 LCLS-II Software Review, November 14, 2018

Software Specifications PID Loops: A sample from the Gas Management Software Specification 79120- C6002 LCLS-II Software Review, November 14, 2018

From 4K Cold Box Control Philosophy C1303-N400 Other Automation: From 4K Cold Box Control Philosophy C1303-N400 LCLS-II Software Review, November 14, 2018

PLC Software With the software specifications in hand, the software engineer can now program the PLC software for that system. The LCLS-II software is based on the software running at JLab. The JLab software is very modular, so it is easily adapted to any differences between the JLab and LCLS-II systems. The LCLS-II warm and recovery compressor software are copies of the software running at JLab. The software and specification will be completed together in case any changes to the specification are necessary. LCLS-II Software Review, November 14, 2018

Traceability P&ID 79120-0002 Wiring Drawing 79120-1505 FMEA Functional Narrative 79120-M0001 LCLS-II Software Review, November 14, 2018

Traceability Gas Management Software Specification 79120-C6002 Gas Management PLC Software LCLS-II Software Review, November 14, 2018

Test Plan A sample of the Software Test Specification 79120-C6004 This includes both bench testing and precommissioning testing. LCLS-II Software Review, November 14, 2018

Test Report The Software Testing Form (79120-C6005) will be used for recording test results. LCLS-II Software Review, November 14, 2018

Charge 1. GENERAL a. Is the documentation and coding maturity consistent with the schedule? Yes. 2. EQUIPMENT PROTECTION a. Are all equipment protection functions (in particular responses to abnormal conditions such as trips, alarms and interlocks) comprehensive, clearly identified, documented, implemented and traceable to the PLC code? Yes. 3. DEFINITION AND DOCUMENTATION a. Are all automated functions (Alarms, Trips, Interlocks / Permissive, Cause and Effects, Control Loops, and Automated Sequences) sufficiently documented for Coding, Testing, Commissioning, Operation and Troubleshooting? Yes. b. Is there traceability between documentation and the PLC code? Yes. 4. CODING a. Are coding rules adequately defined and implemented? Yes. b. Is the PLC code clearly developed, and consistent with documentation and coding rules? Yes. 5. BENCH TESTING a. Has JLAB developed an appropriate plan for testing the CRYOPLANT control systems? Yes. b. Is the EPICS HMI testing integrated with the PLC tests? Yes. LCLS-II Software Review, November 14, 2018

THANK YOU FOR KIND ATTENTION LCLS-II Software Review, November 14, 2018