EPICS Documentation
This is the parent project for all EPICS related documentation on read-the-docs.
A good part of the EPICS documentation is dynamically created and hosted by read-the-docs, which acts as a CI system, building and hosting documentation from source or dedicated documentation repositories.
Read-the-docs offers valuable features that we use:
Keeps complete frozen documentation trees of all released versions under a permalink with the release number.
Keeps the documentation of the development tree (usually ‘master’) up-to-date and accessible using ‘latest’ as release number.
Switching versions is available through the web browser.
This parent project page is not directly linked from the EPICS web site. It creates the link to the canonical URL https://docs.epics-controls.org - links from the EPICS web site to the documentation should point to the subprojects using the canonical URL, e.g., ‘https://docs.epics-controls.org/projects/<project-slug>’
There are two kinds of subprojects:
Code repositories: The documentation is created from comments in the source code (Javadoc or Doxygen) and separate documents (PDF, Markdown, restructuredText). Documentation trees of released versions are kept for reference.
Documentation repositories: The repositories contain only documentation (like FAQs and How-To-Pages). Usually only one version exists (‘latest’).
- Getting started with EPICS
- Installation on Linux/UNIX/DARWIN (Mac)
- Packages required for EPICS on Centos 8
- Creation of an Input/Output Controller (IOC)
- Installation on Windows
- How to Set Up a Soft IOC Framework on Linux
- How to Set Up Console Access and Logging for VME and Soft IOCs
- PV Save and Restore Tools available
- How to Configure Channel Access
- How to Make Channel Access Reach Multiple Soft IOCs on a Linux Host
- Common Database patterns
- How to avoid copying arrays with waveformRecord
- How to find which IOC provides a PV
- Application Developer's Guide (pdf, 3.16.2)
- Application Developer's Guide (web version, preliminary)
- EPICS Process Database Concepts
- How to Add a New Breakpoint Table
- Database Examples (external link)
- Record Reference