NSLS2 / NSLS2/nsls2api

Make "detectors" generic to "instruments"

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

Nobody has claimed this yet.

Dominant language
Python
Stars
0
Forks
13
Avg merge
1h 17m
Merged PRs (30d)
1

Description

In speaking with Bruce, he shared an opinion that assets directories are needed for more than just detectors, i.e. other kinds of instruments that aren't considered to be detectors. This opinion is consistent with the motivation of assets, we just didn't spend a lot of time thinking about the name used in the backend.

The mechanism is sufficient to create whatever arbitrary instrument directories as-is, of course, but it might better to reflect the intended usage throughout the API and database layers.

Contributor guide

No contributing guide indexed for this repository

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 locating detector-specific names across the API and database layers, then trace how asset directories and instrument records are represented. Update the relevant references from detectors to instruments while preserving support for arbitrary instrument directories, and verify the API and database behavior.

Written by the indexing model from the issue text.

Assessment

Tech stack
fastapi, python
Domain
api, database
Issue type
Refactor
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.