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

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)


McStas: Progress_bar

[ Identification | Description | Input parameters | Links ]

The Progress_bar Component

A simulation progress bar

Identification

  • Site:
  • Author: Emmanuel Farhi
  • Origin: ILL
  • Date: 2002

Description

An indicator of the progress of the simulation, monitoring
the Init, Trace with the achieved percentage, and the Finally section.
Intermediate savings (e.g. triggered by USR2 signal) are also shown.
This component should be positioned at the very begining of the instrument
The profile option will save the intensity and number of events for each
component It may be used to evaluate the simulation efficiency.

Example: Progress_bar(percent=10,flag_save=1) AT (0,0,0)

Input parameters

Parameters in boldface are required; the others are optional.
NameUnitDescriptionDefault
profilestrfile name to save the simulation profile if set to "", it is set to the name of the instrument."NULL"
percent0-100percentage interval between updates. Default is 10%.10
flag_save0|1flag to enable intermediate saving for all monitors0
minutesmintime in minutes between updates (Overrides percent flag).0
AT ( , , ) RELATIVE
ROTATED ( , , ) RELATIVE

Links


[ Identification | Description | Input parameters | Links ]

Generated on 2024-01-03 11:47:43


Last Modified: Wednesday, 03-Jan-2024 19:59:11 CET
Search website mailinglist archive GitHub repos