coniql

Control system interface in GraphQL with plugins for EPICS Channel Access and PV Access. Supports a web interface to get, put and monitor the value of PVs.

How the documentation is structured

Documentation is split into four categories, also accessible from links in the side-bar.

Tutorials

Tutorials for installation, library and commandline usage. New users start here.

Tutorials

• Installation
  • Check your version of python
  • Create a virtual environment
  • Installing the library

How-to Guides

Practical step-by-step guides for the more experienced user.

How-to Guides

• Run a server
  • Running a server
    • Getting a channel
    • Subscribing to a Channel
  • Sim Plugin
  • CA Plugin
  • PVA Plugin

Explanations

Explanation of how the library works and why it works that way.

Explanations

• Why GraphQL?

Reference

Practical step-by-step guides for the more experienced user.

Reference

• API
  • coniql
  • coniql.__version__
• Benchmarking
  • Instructions
    • Prerequisites
    • Bash script
    • Expected Results
• Contributing
  • Running the tests
  • Code Styling
  • Documentation
  • Release Process
  • Updating the tools
• Performance
  • Investigating Coniql Performance
    • Method
    • Findings
• Releases
• Index

About the documentation

Why is the documentation structured this way?