Need documentation describing the standard layout file
Closed this issue · 1 comments
Brad0440 commented
The documentation needs to be updated with information about the standard file format which is used by functions such as BMS.Import_Labware_Layout
.
I've created a page for this here.
Brad0440 commented
The documentation page now has sections created. Guidance for essential info required is below. Feel free to add an extra info that might be needed.
Overview
- What is the layout file?
- What information can it store?
- What can it be used for?
Specification
- Describe the various aspects of the file (an excel book with two sheets)
- Show what gets stored and where (annotated images of an example would be good here)
- Make clear what is optional and what is mandatory in terms of columns to include, and information for each sample
Example Usage
- Show an example of where a standard layout file can be used within BMS - e.g. source plates for an EchoProto template
Resources
- Links to example and empty layout files which can be downloaded and modified by users