# The `template` Instrument

*McXtrace: !!Please write a short instrument (1 line) here!!*

## Identification

- **Site:** Templates
- **Author:** Your name (email)
- **Origin:** Your institution
- **Date:** Current Date

## Description

```text
Instrument longer description (type, elements, usage...)

Example: mcrun template.instr <parameters=values>

once your instrument is written and functional:
- replace INSTRUMENT_SITE entry above with your Institution name as a single word
- rename the instrument name after DEFINE INSTRUMENT below
- update the parameter help in the following Parameters section
- update the instrument description, and better add a usage example with a
sensible parameter set.
```

## Input parameters

Parameters in **boldface** are required; the others are optional.

| Name | Unit | Description | Default |
|------|------|-------------|---------|
| Par1 |  |  | 1 |

## Links

- [Source code](template.instr) for `template.instr`.
- A reference/HTML link for more information

---