Ticket #9686 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

update documentation for LoadMcStas

Reported by: Anders Markvardsen Owned by: Anders Markvardsen
Priority: critical Milestone: Release 3.2
Component: Documentation Keywords:
Cc: Torben.Nielsen@… Blocked By:
Blocking: #8957 Tester: Karl Palmen

Description (last modified by Karl Palmen) (diff)

Update doc for LoadMcStas with Torben Nielsen's text:

/*WIKI* 

* Reads a McStas Nexus file into a Mantid WorkspaceGroup with a user-supplied name. Data generated by McStas monitor components are stored in workspaces of type Workspace2D or Event.

* LoadMcStas replaces LoadMcStasEventNexus. LoadMcStas can be used for reading McStas 2.1 histogram and event data. LoadMcStasNexus can be used for reading McStas 2.0 histogram data. 



===McStas compiling and running===
McStas 2.1 event data and the corresponding IDF for Mantid are generated as follows using these commands from an xterm:

* Compile McStas instrument code
** mcstas templateSANS_Mantid.instr --trace

* Compile c code
** gcc -o templateSANS_Mantid.out templateSANS_Mantid.c -lm -DUSE_NEXUS -lNeXus

* Generate IDF
** mcdisplay templateSANS_Mantid.instr --format=Mantid -n0

* Run simulation
** ./templateSANS_Mantid.out --format=Nexus 

The templateSANS_Mantid.instr file used in the above example can be found in  McStas neutron suite.


===McStas event data conventions===
For McStas to auto generate an IDF the McStas instrument file must obey:

* McStas instrument file name and the McStas defined name of the instrument must be the same
** E.g. templateSANS_Mantid.instr and “DEFINE INSTRUMENT templateSANS_Mantid(…. )” 

* In the McStas instrument file the source must be named “souceMantid”
** E.g. "COMPONENT sourceMantid = Source_simple(…. )"

* In the McStas instrument file the sample must be named “sampleMantid”
** E.g. "COMPONENT sampleMantid = Sans_spheres(…. )"


* In the McStas instrument file the event monitors must be named “nD_Mantid_#”
** E.g. "COMPONENT nD_Mantid_1 = Monitor_nD(…. )" 

The McStas component monitor_nD must be called with the argument: options ="mantid square x limits=[-0.2 0.2] bins=128 y limits=[-0.2 0.2] bins=128, neutron pixel t, list all neutrons".  Number of bins and limits can be chosen freely.

 
===Tested versions===
The new features added to McStas has been tested on the following platforms:

* Linux
* Mac
**Use either the Intel or gcc 4.8 compiler. Simulations using Nexus format and event data does not work using the Clang compiler.


===References===
For more information about McStas and its general usage for simulating neutron scattering instruments and experiments visit the McStas homepage http://www.mcstas.org.

*WIKI*/

Change History

comment:1 Changed 6 years ago by Anders Markvardsen

  • Status changed from new to assigned

comment:2 Changed 6 years ago by Anders Markvardsen

  • Priority changed from major to critical

comment:3 Changed 6 years ago by Anders Markvardsen

  • Status changed from assigned to inprogress

Update to doc for loadmcstas. re #9686

provided by Torben and translated to rst format

Changeset: b555e780644291fb16d23cd85e75220edd5e665d

comment:4 Changed 6 years ago by Anders Markvardsen

  • Status changed from inprogress to verify
  • Resolution set to fixed

To tester:

Check that Torben WIKI updated text have been translated OK to LoadMcStas-v1.rst

comment:5 Changed 6 years ago by Michael Reuter

  • Status changed from verify to verifying
  • Tester set to Michael Reuter

comment:6 Changed 6 years ago by Michael Reuter

  • Status changed from verifying to reopened
  • Resolution fixed deleted

The page is producing the following warnings. Also, the double-dash flags are rendered as single dashes. It looks the content has been transferred over correctly.

comment:7 Changed 6 years ago by Anders Markvardsen

  • Status changed from reopened to inprogress

using fixed space literal instead of bold. re #9686

Changeset: f846c7e0e2591114e9a637ab9fe0b234fcb0635f

comment:8 Changed 6 years ago by Anders Markvardsen

  • Status changed from inprogress to verify
  • Resolution set to fixed

Tx to Michael for spotting missed warning.

Warning appear to be cleared in http://builds.mantidproject.org/job/develop_clean/167/warnings2Result/NORMAL/package.-1966826692/

To tester: see comment 4

comment:9 Changed 6 years ago by Karl Palmen

  • Description modified (diff)

Modify description so that Torben Nielsen's test is displayed as is and unwanted bolding is removed.

comment:10 Changed 6 years ago by Karl Palmen

  • Status changed from verify to verifying
  • Tester changed from Michael Reuter to Karl Palmen

comment:11 Changed 6 years ago by Karl Palmen

The rst file seems to be good translation, but still needs a usage example.

Please create a ticket for the usage example, if one does not already exist.

comment:12 Changed 6 years ago by Karl Palmen

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/9686_mcstas_doc_update'

Full changeset: 2ebad7dfb3f3af55a1becc87996a993cef7a977e

comment:13 Changed 6 years ago by Nick Draper

comment post to wrong ticket

Last edited 6 years ago by Nick Draper (previous) (diff)

comment:14 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 10528

Note: See TracTickets for help on using tickets.