Difference between revisions of "Policies and Procedure"
From EPICSWIKI
Line 20: | Line 20: | ||
== Reminders on Conventions for Development, Deployment, and Documentation == | == Reminders on Conventions for Development, Deployment, and Documentation == | ||
* | === IOC Application Development & Deployment === | ||
* Name new IOC according to naming convention | |||
* Request Ned to define the IOC in IRMIS IOC table | |||
* Request Ned to create iocinfo directories | |||
* Request Randy to enter IOC-specific boot information | |||
* Enter into “Installed Components” … idt::component | |||
* For IOCs on the Controls subnet, install ASDSTD tools | |||
* Boot from /usr/local/iocapps | |||
=== EPICS Device Support Development & Deployment === | |||
* Device support that is likely to be used by more than one top app should be developed as a Module | |||
=== PLC Development & Deployment === | |||
* Name new PLC according to naming convention | |||
* Hardcode version # into the ladder logic and have the IOC read it back to a PV | |||
* Enter PLC tag into the st.cmd file | |||
* Create folder in asdctls/plcapps (follow conventions) for ladder logic | |||
** Create zip and pdf of ladder (follow naming convention) | |||
** Create zip for Touch Screen Code (follow naming convention) | |||
** Check above into ICMS with the PLC name as a keyword | |||
* Enter PLC and I/O modules into idt::components | |||
* Enter “Description” for PLC in IRMIS:PLC Info Viewer | |||
=== Custom Designed Modules/Chassis === | |||
* Place all engineering documentation in asdctls/documentation/components/custom/[component_name] | |||
* If a web page is provided for easy navigation through these folders, put it in the top folder and name it index.html | |||
* Request Ned/Scott to define the component type in IRMIS | |||
* Contribute EPICS device support to EPICS Website | |||
=== Commercial Modules/Components === | |||
* Store User Guides,etc in asdctls/documentation/components/commercial/[component_name] | |||
* Contribute EPICS device support to EPICS Website | |||
=== Installed Systems === | |||
* Define AOI | |||
* Mark up st.cmd file with AOI tags | |||
* Record major changes in worklog | |||
* Check block diagrams, wiring lists, troubleshooting guides, etc into ICMS with the AOI name as a keyword | |||
* Enter all deployed components in idt::component | |||
=== Controls Logbook === | |||
* Record operational issues |
Latest revision as of 18:47, 8 August 2008
Document Central
Document Central is a public repository for controlled documents essential to the safety and operation of the Advanced Photon Source.
Division Controlled Procedures
Lists of the formal procedures (administered by the division)
Group Controlled Procedures
Do I really want to maintain this list??
- APS Standard Procedure for IOC Applications
- PLC Application Management System (PAMS)
- Component-type Documentation Procedure
- APS Site-wide Process Variable Naming Convention
- PV Rename Procedure
- Validation Procedures
Reminders on Conventions for Development, Deployment, and Documentation
IOC Application Development & Deployment
- Name new IOC according to naming convention
- Request Ned to define the IOC in IRMIS IOC table
- Request Ned to create iocinfo directories
- Request Randy to enter IOC-specific boot information
- Enter into “Installed Components” … idt::component
- For IOCs on the Controls subnet, install ASDSTD tools
- Boot from /usr/local/iocapps
EPICS Device Support Development & Deployment
- Device support that is likely to be used by more than one top app should be developed as a Module
PLC Development & Deployment
- Name new PLC according to naming convention
- Hardcode version # into the ladder logic and have the IOC read it back to a PV
- Enter PLC tag into the st.cmd file
- Create folder in asdctls/plcapps (follow conventions) for ladder logic
- Create zip and pdf of ladder (follow naming convention)
- Create zip for Touch Screen Code (follow naming convention)
- Check above into ICMS with the PLC name as a keyword
- Enter PLC and I/O modules into idt::components
- Enter “Description” for PLC in IRMIS:PLC Info Viewer
Custom Designed Modules/Chassis
- Place all engineering documentation in asdctls/documentation/components/custom/[component_name]
- If a web page is provided for easy navigation through these folders, put it in the top folder and name it index.html
- Request Ned/Scott to define the component type in IRMIS
- Contribute EPICS device support to EPICS Website
Commercial Modules/Components
- Store User Guides,etc in asdctls/documentation/components/commercial/[component_name]
- Contribute EPICS device support to EPICS Website
Installed Systems
- Define AOI
- Mark up st.cmd file with AOI tags
- Record major changes in worklog
- Check block diagrams, wiring lists, troubleshooting guides, etc into ICMS with the AOI name as a keyword
- Enter all deployed components in idt::component
Controls Logbook
- Record operational issues