Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
mcdoc(1)			 USER COMMANDS			      mcdoc(1)

NAME
       mcdoc  -	 documentation tool of the McStas neutron ray-trace simulation
       package

SYNOPSIS
       mcdoc [-mc] [comp|instr]

DESCRIPTION
       The mcdoc command is the	documentation tool of the McStas  package.  It
       opens a browser to display help ressources.

       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 spec-
       ification 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 documenta-
	      tion  for	the Help menu. It contains an instrument editor, meth-
	      ods 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
       The  usage  of  the command does	not require option. Refer to mcplot -h
       for special uses.

       -h | --help
	      displays the command help

       -c     opens the	Component manual

       -m     opens the	User manual

EXAMPLES
       Typical usage
	      mcdoc

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.

       The BROWSER environment variable	may be set to define the default  HTML
       browser to use

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 Lieu-
       tenant

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)

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

NAME | SYNOPSIS | DESCRIPTION | OPTIONS | EXAMPLES | ENVIRONMENT | BUGS | AUTHOR | SEE ALSO

Want to link to this manual page? Use this URL:
<https://www.freebsd.org/cgi/man.cgi?query=mcdoc-2.2a&sektion=1&manpath=FreeBSD+11.0-RELEASE+and+Ports>

home | help