IOC_Generator

Generates the boilerplate structure required for developing an IBEX IOC. It will only add the items you request by prompting you before each item.

Have EPICS Terminal open for this (You can obtain it for example using C:\Instrument\Apps\EPICS\config_env.bat) Run the script (e.g. in C:\Instrument\Dev\IBEX_device_generator) with the following command

%python3% IBEX_device_generator.py --ioc_name=[NAME] --device_name=[DEVICE] --ticket=[TICKET] --device_count=2 --use_git --github_token [TOKEN]

where:

• ioc_name: the name of the IOC. It is used of generating the PV structure etc.
• device_name: the name of the device. It is used of generating the support module directory, the repository, the device emulator etc. (This is optional and if omitted will just mirror ioc_name)
• ticket: is the ticket number. It is used for naming the branches created during the script.
• device_count: the number of IOCs to generate. This argument is optional and defaults to 2.
• use_git: use to create relevant branches. Remote repository must exist.
• github_token: your GitHub authentication token with repo scope. Use to create support repository. (How to create token: https://docs.github.com/en/authentication/keeping-your-account-and-data-secure/managing-your-personal-access-tokens)

The script runs the following steps:

• Create the support GitHub repository.
• Grant Write access to the ICP-Write team and Maintain access to the ICP-WriteAndMerge team.
• Add an EPICS submodule for the device
• Add boilerplate code to the support submodule
  • If you get an error message stating that the directory is not found in C:\Instrument\Apps\EPICS\support\[ioc name], create a folder inside support directory (use name of the ioc, in lower case) and run the script again.
• Create device_count template IOCs, build them and run make iocstartups
• Create a standalone Lewis emulator
• Add a sample test suite to the IOC test framework and add it to run_all_tests.bat
• Create a blank OPI and add it to opi_info.xml