Context Navigation

← Previous Ticket
Next Ticket →

Ticket #9567 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Check Documentation and add algorithm usage examples

Reported by:	Nick Draper	Owned by:	Karl Palmen
Priority:	critical	Milestone:	Release 3.2
Component:	Documentation	Keywords:
Cc:		Blocked By:
Blocking:		Tester:	Roman Tolchenov

Description

Please check the documentation for these algorithms (check images, formatting etc) and add testable algorithm usage examples. We have tried to allocate algorithms as fairly and sensibly as possible, but there will be some that you do not consider "yours".

There is help on how to document the algorithms in the following links: http://www.mantidproject.org/Algorithm_Documentation http://www.mantidproject.org/Algorithm_Usage_Examples And there are examples implemented for Fit, Load, LoadISISNexus and Rebin.

To create workspaces to use in your usages you should try to create the workspace using CreateSampleWorkspace or CreateWorkspace, and only use a file if you really have no other option and the size is small.

In Visual studio you have two targets to create the documentation and run the doc tests (docs-html and docs-test in a documentation subfolder). You will need to update your Third Party Library.

If you are using Linux/Mac look here: https://github.com/mantidproject/mantid/blob/master/Code/Mantid/docs/README.md

ApplyCalibration.cpp
ApplyDetailedBalance.cpp
CopyInstrumentParameters.cpp
CopyLogs.cpp
CreateTransmissionWorkspace.cpp
FilterEvents.cpp
MaskBinsFromTable.cpp
NormaliseToUnity.cpp
PerformIndexOperations.cpp
ReflectometryReductionOne.cpp
CreateGroupingWorkspace.cpp
GeneralisedSecondDifference.cpp
GetTimeSeriesLogInformation.cpp
MaskBins.cpp
NormaliseByCurrent.cpp
NormaliseToMonitor.cpp
ReadGroupsFromFile.cpp
MaxMin.cpp
FindPeaks.cpp
CreateCalFileByNames.cpp
RemoveBins.cpp
CreateDummyCalFile.cpp
SumRowColumn.cpp
ThresholdMD.cpp
MDHistoToWorkspace2D.cpp
ClearUB.cpp
GoniometerAnglesFromPhiRotation.cpp
IndexPeaks.cpp
ShowPeakHKLOffsets.cpp
StepScan.cpp
LoadFullprofResolution.cpp
LoadGSASInstrumentFile.cpp
LoadIDFFromNexus.cpp
ModifyDetectorDotDatFile.cpp

Change History

comment:1 Changed 6 years ago by Nick Draper

Status changed from new to assigned

comment:2 Changed 6 years ago by Karl Palmen

I sort and group the algorithms according to their folder/category

Algorithms:

ApplyCalibration.cpp
ApplyDetailedBalance.cpp
CopyInstrumentParameters.cpp
CopyLogs.cpp
CreateCalFileByNames.cpp
CreateDummyCalFile.cpp
CreateGroupingWorkspace.cpp
CreateTransmissionWorkspace.cpp
FilterEvents.cpp
FindPeaks.cpp
GeneralisedSecondDifference.cpp
GetTimeSeriesLogInformation.cpp
MaskBins.cpp
MaskBinsFromTable.cpp
MaxMin.cpp
NormaliseByCurrent.cpp
NormaliseToMonitor.cpp
NormaliseToUnity.cpp
PerformIndexOperations.cpp
ReadGroupsFromFile.cpp
ReflectometryReductionOne.cpp
RemoveBins.cpp
SumRowColumn.cpp

Crystal:

ClearUB.cpp
GoniometerAnglesFromPhiRotation.cpp
IndexPeaks.cpp
ShowPeakHKLOffsets.cpp

DataHandling:

LoadFullprofResolution.cpp
LoadGSASInstrumentFile.cpp
LoadIDFFromNexus.cpp
ModifyDetectorDotDatFile.cpp

MD Algorithms:

ThresholdMD.cpp

SINQ:

MDHistoToWorkspace2D.cpp

WorkflowAlogirthms:

StepScan.cpp