Ticket #7990 (closed: fixed)

Opened 7 years ago

Last modified 5 years ago

Add documentation to Stitch command for ORNL SANS

Reported by: Mathieu Doucet Owned by: Mathieu Doucet
Priority: major Milestone: Release 3.0
Component: Documentation Keywords:
Cc: Blocked By:
Blocking: Tester: Samuel Jackson

Description

The ORNL SANS command "Stitch" doesn't have documentation when you do help(Stitch).

Change History

comment:1 Changed 7 years ago by Mathieu Doucet

  • Status changed from new to inprogress

Re #7990 add help doc

Changeset: 55cf5670c0759e05176a1fa7beb73b3a005fa35a

comment:2 Changed 7 years ago by Mathieu Doucet

Re #7990 catch more error conditions

Changeset: 1d2732914046ac0a742a28adb12c4038dc60e7eb

comment:3 Changed 7 years ago by Mathieu Doucet

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

To test:

  • Check that the stitching works by trying to stitch SANS data from the reference results directory. Executing the following script should load and scale the data. It should also produce a new workspace named 'stitched' with the stitched result. It should also write a file 'stitched.xml' in your default output directory in Mantid.
    import os
    from reduction_workflow.instruments.sans.sns_command_interface import *
    data_dir = "~git/systemtests/SystemTests/AnalysisTests/ReferenceResults/"
    data_list = [os.path.join(data_dir, "HFIRReduction.nxs"),
                 os.path.join(data_dir, "EQSANSIQOutput.nxs") ]
    Stitch(data_list, 0.04, 0.06, 'stitched', 2.0, True)
    
  • Check that documentation is available by doing:
    from reduction_workflow.instruments.sans.sns_command_interface import *
    help(Stitch) 
    

comment:4 Changed 7 years ago by Samuel Jackson

  • Status changed from verify to verifying
  • Tester set to Samuel Jackson

comment:5 Changed 7 years ago by Samuel Jackson

  • Status changed from verifying to closed

Merge remote-tracking branch 'origin/feature/7990_SANS_Stitch_Doc'

comment:6 Changed 7 years ago by Samuel Jackson

Stitch does what it's supposed to do and documentation is shown when running help().

comment:7 Changed 7 years ago by Nick Draper

  • Component changed from Framework to Documentation

comment:8 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 8835

Note: See TracTickets for help on using tickets.