Ticket #174 (closed: fixed)

Opened 12 years ago

Last modified 5 years ago

Write documentation to help users write their first few algorithms

Reported by: Nick Draper Owned by: Russell Taylor
Priority: major Milestone: Iteration 12
Component: Keywords:
Cc: Blocked By:
Blocking: Tester:

Description (last modified by Nick Draper) (diff)

This will need to explain the algorithm lifecycle, and describe all of the object provided within an algorithm and how to use them.

We need to aim this at people with minimal programming knowledge and include plenty of examples.

It should be written assuming that people are using the installed version of Mantid and building using the Build.bat available from the UserAlgorithms directory.

Change History

comment:1 Changed 12 years ago by Nick Draper

  • Milestone changed from Iteration 10 to Iteration 11

comment:2 Changed 12 years ago by Nick Draper

  • Owner set to Russell Taylor
  • Description modified (diff)

comment:3 Changed 12 years ago by Russell Taylor

(In [1364]) Made ArrayProperty constructors more consistent. Re #174.

comment:4 Changed 12 years ago by Russell Taylor

(In [1368]) Add simple python script to create and algorithm 'stub'. Will go into UserAlgorithms directory of a Mantid install. Re #174.

comment:5 Changed 12 years ago by Nick Draper

  • Milestone changed from Iteration 11 to Iteration 12

comment:6 Changed 12 years ago by Russell Taylor

(In [1376]) Improved some tests. Re #174.

comment:7 Changed 12 years ago by Russell Taylor

  • Status changed from new to closed
  • Resolution set to fixed

comment:8 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​1022

Note: See TracTickets for help on using tickets.