Add glossary and style guide #1844
Conversation
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1844 +/- ##
=======================================
Coverage 99.05% 99.05%
=======================================
Files 289 289
Lines 11030 11060 +30
=======================================
+ Hits 10926 10956 +30
Misses 104 104 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1844 +/- ##
=======================================
Coverage 99.05% 99.05%
=======================================
Files 289 289
Lines 11030 11060 +30
=======================================
+ Hits 10926 10956 +30
Misses 104 104 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
oliwenmandiamond
left a comment
oliwenmandiamond
left a comment
There was a problem hiding this comment.
I think this looks really good and have no objections. Probably need a wider consensus than just myself though
Villtord
left a comment
Villtord
left a comment
There was a problem hiding this comment.
Thanks it looks great!
I am not a native English speaker so please double check my suggestions :)
|
|
||
| ## Acronyms | ||
|
|
||
| | Acronym | Explanation | |
There was a problem hiding this comment.
Maybe "Full name" is more appropriate than "Explanation" here?
|
|
||
| ## Abbreviations | ||
|
|
||
| | Abbreviation | Explanation | |
There was a problem hiding this comment.
Maybe "Full name" is more appropriate than "Explanation" here?
| | device | Hardware defined via ophyd protocols, although ophyd-async is the standard implementation at Diamond. | | ||
| | endstation | An endstation is a collection of devices which can be used together to run experiments, usually distinct from optical devices on a beamline. Beamlines may have one or more endstations which can be used for data collection either in parallel or exclusively. | | ||
| | graylog | A log management platform, which all container stdout/stderr logs are sent to at DLS. | | ||
| | ISPyB | A managed environment for keeping track of your experiments at some Diamond beamlines. | |
There was a problem hiding this comment.
I am not a native English speaker so please double check my suggestions :)
| | ISPyB | A managed environment for keeping track of your experiments at some Diamond beamlines. | | |
| | ISPyB | A managed experimental information service for keeping track of your experiments at some Diamond beamlines. | |
| | ----------- | -----------| | ||
| | blueapi | Lightweight bluesky-as-a-service wrapper application. Also usable as a library. | | ||
| | bluesky | Bluesky is a library for experiment control and collection of scientific data and metadata. | | ||
| | beamline | A beamline is a collection of devices that can be used together to run experiments, they may be read-only or capable of being set. | |
There was a problem hiding this comment.
| | beamline | A beamline is a collection of devices that can be used together to run experiments, they may be read-only or capable of being set. | | |
| | beamline | A beamline is a collection of all devices used to run experiments that make synchrotron light (beam) from a given insertion device produce experimental data, they may be read-only or capable of being set. | |
Adds a glossary of terms, and style guide.
Closes #876 and #1481.
Instructions to reviewer on how to test: