ESS EPICS Environment (e3) build tools¶
ESS’ EPICS Environment (e3) is a design concept and a toolkit intended to
facilitate development by abstracting away some of the low-level complexities intrinsic to large EPICS implementations (primarily dependency management), and to
allow for more manageable quality control of released modules as well as IOCs.
It allows for easily building EPICS modules directly from source and automagically resolves module dependencies, and allows for site-specific modifications to EPICS modules without needing to directly modify source trees.
Quickstart
Design
Knowledge-base
- Training
- 1. Installing e3
- 2. An e3 IOC
- 3. Installing other versions of modules
- 4. Startup scripts in e3
- 5. Anatomy of an e3 module
- 6. Variables within e3
- 7. Understanding module dependence
- 8. Building an e3 module
- 9. Other dependencies
- 10. Additional working modes
- 11. Supplementary tools
- Answers to exercises, assignments, and questions
- User guides
- How to: Troubleshoot build system errors
- How to: Investigate a segmentation fault
- How to: Install e3 on Windows 10/11 with WSL
- How to: Create an e3 wrapper with cookiecutter
- Article: The build process with require (In-depth; advanced)
- Article: Configuring your wrapper
- Article: Community collaboration
- Article: e3 Cheatsheet
- How to: Build dynamic kernel module support (DKMS)
- Article: How to automate tests for your module
- Article: require targets
- Debugging e3
- API Reference
Source¶
The source code for these docs is kept at:
https://gitlab.esss.lu.se/e3/e3-build-tools
Generally, all ESS e3-related repositories are kept under:
The source modules (including applications and libraries) are generally kept under:
https://gitlab.esss.lu.se/epics-modules
And IOCs are kept under: