Home

Wiki

The instrument script repository provides a common repository for creating instrument scripts at ISIS. This wiki contains some documentation for the scripts and the process for editing those scripts.

Code Repository

There is a single code repository which contains the code for all instruments; this allows maximum amount of sharing of code. However, with great power comes great responsibility; if you make an edit that could effect more than just your instrument think carefully. When you get the current code make sure you are getting changes that you want. The directory structure should help separate out changes that effect you. All the code lives in the directory c:\Instrument\scripts and within this the directories are as follows.

Instrument Specific Scripts

Scripts which are used on a single instrument (scripts\instrument\<instrument name>).

Technique Specific Scripts

Scripts which needs to be shared between a small number of instruments usually based on a technique (scripts\techniques\<technique name>)

General Scripts

Scripts which could be useful on all instruments (scripts\general\<module name>)

Processes

Getting the Latest Version of the Code

How to download the latest version of the code onto your instrument.

Editing the Wiki

How, when and why to edit this wiki.

Contributing to the Code

How to contribute to the code.

Testing the Code

You should write tests for the code, this documents were and how.

Code Techniques

Common and useful ways of coding scripts, e.g. how to make a script which works on multiple instruments but with an instrument specific code.

Code Style

This is the suggested code style, follow if possible.

TODO - If requested

• Create a git hook to enforce name in commit comments, if committing as instrument user? This may not be possible.
• Create a Jenkins build
• Create a document compiler and place for documents to live (add links in wiki)
• Add integration into genie_python (add path c:\instrument\setting\*)