Ticket #11083 (closed: fixed)

Opened 6 years ago

Last modified 5 years ago

Review indirect algorithm documentation

Reported by: Dan Nixon Owned by: Dan Nixon
Priority: major Milestone: Release 3.4
Component: Documentation Keywords:
Cc: spencer.howells@… Blocked By:
Blocking: Tester: Raquel Alvarez

Description (last modified by Dan Nixon) (diff)

Some of the documentation for indirect algorithms is extremely sparse and could do with being updated.

This should deal with:

  • Ensuring the theory is documented correctly
  • Ensuring usage examples exist and are suitable

Algoithms in need of attention

  • CreateCalibrationWorkspace (needs to be renamed
  • IndirectTransmissionMonitor
  • IndirectResolution
  • JumpFit
  • ElasticWindow

Change History

comment:1 Changed 6 years ago by Dan Nixon

  • Status changed from new to assigned

comment:2 Changed 6 years ago by Dan Nixon

  • Description modified (diff)

comment:3 Changed 6 years ago by Dan Nixon

  • Description modified (diff)

comment:4 Changed 6 years ago by Dan Nixon

  • Status changed from assigned to inprogress

Renamed CreateCalibrationWorkspace to IndirectCalibration

Refs #11083

Changeset: 370841c85759a460adfa7cec883992c93a17821b

comment:5 Changed 6 years ago by Dan Nixon

Refactoring, new usage example for calibration

Refs #11083

Changeset: 5544aa174f4bbe11eb611df4e2bf00489f28af88

comment:6 Changed 6 years ago by Dan Nixon

Improve docs for calibration and transmission

Refs #11083

Changeset: f91707ad8b14783cbe131f0686017ece2ed4ac8f

comment:7 Changed 6 years ago by Dan Nixon

More refactoring and tests

Refs #11083

Changeset: 59a57eb0cf4cf324c1d62dc44a31661618522b74

comment:8 Changed 6 years ago by Dan Nixon

Add Simulation algorithm catagory

Refs #11083

Changeset: baae912bed38ea746aef1fb61f165dbc7b7e73e8

comment:9 Changed 6 years ago by Dan Nixon

Add doc test for JumpFit

Refs #11083

Changeset: 96abcc2cb07f8e39cb5f0d07c18eff8570510176

comment:10 Changed 6 years ago by Dan Nixon

Merge branch 'master' into 11083_indirect_algorithm_cleanup

Conflicts:

Code/Mantid/Testing/SystemTests/tests/analysis/ISISIndirectInelastic.py

Refs #11083

Changeset: 2d174d3fc345d3953e8257f2b9c91554f40ec871

comment:11 Changed 6 years ago by Dan Nixon

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

This is being verified as ​pull request #422.

comment:12 Changed 6 years ago by Dan Nixon

Fix algorithm catagory system test

Refs #11083

Changeset: ddbe3037c767d96879030f3b08678c4e100c8dac

comment:13 Changed 6 years ago by Dan Nixon

Fix JumpFit usage example test

Refs #11083

Changeset: a889a2ef7bcfd7a6c492d3df7c643b9ae1d3007a

comment:14 Changed 6 years ago by Raquel Alvarez

  • Status changed from verify to verifying
  • Tester set to Raquel Alvarez

comment:15 Changed 6 years ago by Dan Nixon

Correct spelling error

Refs #11083

Changeset: 2e589cf4b6d54b07bfa5ae979849587ae8e5766c

comment:16 Changed 6 years ago by Raquel Alvarez

  • Status changed from verifying to closed

Merge pull request #422 from mantidproject/11083_indirect_algorithm_cleanup

Improve some Indirect algorithm documentation

Full changeset: ​200b6b8eb9c4c039ae50b6b4cac239c261905ada

comment:17 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​11922

Note: See TracTickets for help on using tickets.