ISISNeutronMuon / ISISNeutronMuon/SScanSS-2

Change the instrument schema to make the list of collimators a part of detector objects

Open
#68 0 comments 0 reactions 0 assignees View on GitHub
module: documentation module: instruments Type: enhancement
Dominant language
Python
Stars
8
Forks
10
PR merge metrics
No merged PRs in 30d

Description

Change the instrument schema to instead of having a list of **collimators** as a part of the **instrument**, make it part of a **detector** object.

Right now the **collimator** has the **detector** it is attached to as a string inside it, allowing to have **collimators** with the same name if they are attached to different **detectors**. It would be more logical if instead **collimators** would be a part of the **detector** object they are attached to like **links** and **joints** are a part of the **positioner** object.

It would require:
* Update how the Json files are processed into an instrument
* Implement backwards compatibility to be able to read and convert files of old schema into the new one
* Update documentation about the Instrument Schema

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.