pcdshub / pcdshub/lightpath

Lightpath as a Service

Open
#105 0 comments 4 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
4
Forks
9
Avg merge
7d 14h
Merged PRs (30d)
1

Description

Expected Behavior

Built-in mechanism for running a lightpath server process that loads a beamline and responds to requests from various clients about the state of the beam. This could have multiple interfaces that could be enabled/disabled in the server configuration, for example:

  • json blob via http requests
  • EPICS PVs via caproto
  • PVA PVs via ???

Current Behavior

No such service, though an IOC has been proposed before in #99

Context

These could be used for smaller programs that don't have full knowledge of the beamline to get information about localized beam status. Consider typhos for example, which could display whether or not there is beam at a particular mirror, without having a giant screen open to cross-reference or needing to load a full lightpath on the client.

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start by reviewing this issue and the earlier IOC proposal in #99. Clarify the server lifecycle, beamline loading, request model, and configurable interfaces before identifying implementation entry points. Done would require an agreed design and a working service that exposes beam state through the selected interfaces.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
api, backend
Issue type
Feature
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.