McStas logo McStas - A neutron ray-trace simulation package ILL; PSI; ESS Niels Bohr Institute DTU Physics

McStas

About McStas
 Conditions of use
 Authors/Contacts
 Project funding

Download
 Components
 Other Downloads (share)

Mailing list

Search web/mailinglist

Documentation
 Wiki (GitHub)
 McStas manual
 Publications

Links

Report bugs (GitHub)

Code-repository (GitHub)


Documentation

1.6  Documentation

As a complement to this Component Manual, we encourage users to use the mcdoc front-end which enables to display both the catalog of the McStas library, e.g using:

1  mcdoc

as well as the documentation of specific components, e.g with:

1 mcdoc searchterm 
2 mcdoc file.comp

The first line will search for all components matching searchterm, and open (or list, if BROWSER is unset) their documentation. For instance, mcdoc laz will list all available Lazy data files, whereas mcdoc Monitor will list most Monitors. The second example will display the help corresponding to the file.comp component, using your BROWSER setting, or as text if unset. The --help option will display the command help, as usual.

An overview of the component library is also given at the McStas home page [Mcsa] and in the User Manual [Wil+05].


Last Modified: Tuesday, 06-Oct-2026 21:19:10 CEST
Search website mailinglist archive GitHub repos