GSP
Quick Navigator

Search Site

Unix VPS
A - Starter
B - Basic
C - Preferred
D - Commercial
MPS - Dedicated
Previous VPSs
* Sign Up! *

Support
Contact Us
Online Help
Handbooks
Domain Status
Man Pages

FAQ
Virtual Servers
Pricing
Billing
Technical

Network
Facilities
Connectivity
Topology Map

Miscellaneous
Server Agreement
Year 2038
Credits
 

USA Flag

 

 

Man Pages


Manual Reference Pages  -  MCDISPLAY-2.2A (1)

NAME

mcdisplay - instrument geometry and neutron trajectory viewer of the McStas neutron ray-trace simulation package

CONTENTS

Synopsis
Description
Options
Instrument Options
Examples
Environment
Bugs
Author
See Also

SYNOPSIS

mcdisplay [-mzipfh][-gif|-ps|-psc] file.instr param1=val ...

DESCRIPTION

The mcdisplay command is the instrument geometry and neutron trajectory viewer of the McStas package. It opens a plot window showing the instrument geometry. Additionally, neutron trajectories can be followed during their propagation between components. It also compiles the instrument whenever necessary.

McStas is a general tool for simulating neutron scattering instruments and experiments. It is actively supported by Risoe National Laboratory and ILL

McStas is based on a compiler [mcstas(1)] that reads a high-level specification language defining the instrument to be simulated and produces C code that performs the Monte Carlo Simulation. The system is very fast in use, both when setting up the instrument definition and when doing calculations.

McStas supports all neutron scattering instruments, including triple-axis, time-of-flight instruments, and polarised neutrons. It comes with a comprehensive manual and a library of well-tested components that include most standard elements of neutron scattering instruments, including steady-state and pulsed sources, monochromators/analysers, guides, collimators, vanadium and powder samples, velocity selectors and choppers, and a variety of detectors.

The package consists of the following user commands:
mcgui(1)
  is the graphical user interface. Then use the Neutron Site menu to select an example instrument, and access the whole documentation for the Help menu. It contains an instrument editor, methods to plot simulation results, and much more
mcrun(1)
  is the command-line tool for building and running simulations
mcplot(1)
  is the simulation results plotting tool
mcdisplay(1)
  is the instrument geometry and neutron trajectory viewer
mcdoc(1)
  is the documentation tool
mcstas(1)
  is the instrument compiler
mcformat(1)
  can transform any text data set from one format to an other. It does not support conversion from binary data sets. It can also merge equivalent results.
We encourage users to refer to the User and Component Manuals, which are available with the command mcdoc

OPTIONS

-h | --help
  displays the command help
-m | --multi
Show the three instrument side views
-T | --TOF
  Special Time Of Flight acceptance diagram mode, only with PGPLOT plotter
--tmax=TMAX
  Maximum TOF [ms] (defaults to 50 ms) to be used together with --TOF, only with PGPLOT plotter
-iCOMP | --inspect=COMP
  Show only trajectories reaching component COMP
-pPLOTTER | --plotter=PLOTTER
  Output graphics using PLOTTER={PGPLOT,Matlab,VRML}
-k | --keep
  Plot all neutrons events together (Primarily for use with PGPLOT and -psc / -gif etc.)
-gif | -ps | -psc
  Export figure as gif/b&w ps/color ps and exit

INSTRUMENT OPTIONS

These options apply to the generated instrument code (foo.c and foo.out)
-s SEED | --seed=SEED
  Set random seed (must be non zero)
-n COUNT | --ncount=COUNT
  Set number of neutrons to simulate
-d DIR | --dir=DIR
  Put all data files in directory DIR
-f FILE | --file=FILE
  Put all data in a single file
-t | --trace
  Enable trace of neutron through instrument (must have been set during code generation with mcstas(1)). This is necessary for mcdisplay(1) to run
-g | --gravitation
  Enable gravitation for all trajectories
-a | --data-only
  Do not put any headers in the data files
--no-output-files
  Do not write any data files
-h | --help
  Show help message for the instrument
-i | --info
  Detailed instrument information, including valid parameters
--format=FORMAT
  Output data files using format FORMAT (format list obtained from foo.out -h)

EXAMPLES

Typical usage
  mcdisplay foo.instr param1=value1 ...
Display 3D view with Matlab (when installed)
  mcdisplay -pMatlab foo.instr param1=value1 ..

ENVIRONMENT

The MCSTAS environment variable may be set to define the McStas library location. This is /usr/local/lib/mcstas on Linux systems. Executables are usually located in /usr/local/bin.

BUGS

McStas is a large package, and bugs might be found. If so, please report to http://mcstas.org/McZilla/ and the mailing list mcstas-users@mcstas.org

AUTHOR

Peter Kjaer Willendrup, Emmanuel FARHI, Kim Lefmann, and Klaus Lieutenant

SEE ALSO

mcstas(1), mcrun(1), mcdisplay(1), mcplot(1), mcgui(1), mcdoc(1), mcformat(1)

web site: <http://www.mcstas.org>

mailing list: <mailto:mcstas-users@mcstas.org>

matlab(1), idl(1), octave(1), vitess(1), NISP(1), restrax(1), mcnp(1), tripoli(1)

Search for    or go to Top of page |  Section 1 |  Main Index


McStas 2.2a - May. 29, 2015 MCDISPLAY (1)

Powered by GSP Visit the GSP FreeBSD Man Page Interface.
Output converted with manServer 1.07.