ISISComputingGroup / ISISComputingGroup/IBEX

Script Generator: Training Course

Open
#5,506 0 comments 0 reactions 0 assignees View on GitHub
3
Dominant language
No language data
Stars
6
Forks
2
Avg merge
16h 40m
Merged PRs (30d)
2

Description

As an instrument scientist, I would like to be trained in how to use the Script Generator, so that I can support users as they use it to generate scripts. In particular, I want to understand how to write script definitions, so that I can provide users with the building blocks they need to create scripts to run on my instrument.

#### Acceptance Criteria
1. On completing the Script Generator training course, an Instrument Scientist knows:
1. how to install the Script Generator.
1. the principles on which the Script Generator works.
1. how to use the Script Generator to create, edit & save Script Parameter files.
1. how to use Script Parameter files to generate genie_python scripts.
1. how to write Script Definitions.
1. how to make Script Definitions available to my users.
1. how to provide first line support to my users.
1. The course should comprise
1. some slides to illustrate how to use the Script Generator
1. some worked examples of how to use the Script Generator
1. some worked examples of how to write Script Definition files

#### Notes
1. This should be a a short training course - perhaps 1 hour of tuition. We (the Experimental Controls group) should be able to repeat the course on a regular basis.
1. The principles on which the Script Generator works are:
1. you assemble Script Parameter files from building blocks (called Script Definitions)
1. Script Parameter files are "re-usable" descriptions of how run an experiment
1. Script Parameter files can be used to generate genie_python files
1. The instrument scientists should able to provide simple support to their users (e.g. tell the user how to select Script Definitions from the correct folder, how to edit rows in the Script Parameter table, how to generate a genie_python script).

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.