McXtrace logo

McXtrace - An X-ray ray-trace simulation package

Synchrotron SOLEIL DTU Physics

McXtrace

About McXtrace
 Publications
 Project Partners
 Project People
 Goal

Download
 Components

Mailing list

Search

Documentation
 Manual
 Commands
 Wiki (GitHub)
 Tutorial

Links

Report bugs (GitHub)

Code-repository (GitHub)


McXtrace: template

[ Identification | Description | Examples | Input parameters | Links ]

The template Instrument

!!Please write a short instrument (1 line) here!!

Identification

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

Description

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

Example: mcrun template.instr 

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.

Examples

(Test cases in bold)

Input parameters

Parameters in boldface are required; the others are optional.
NameUnitDescriptionDefault
Par11Example parameter, replace with your own1

Links

  • Source code for template.instr.
  • A reference/HTML link for more information

[ Identification | Description | Examples | Input parameters | Links ]

Generated for mcxtrace 3.10.2


Last Modified: Monday, 02-Nov-2026 22:21:09 CET
Search website mailinglist archive GitHub repos