Ticket #11361 (assigned)

Opened 6 years ago

Last modified 5 years ago

Update documentation of remote algorithms when they become general

Reported by: Federico M Pouzols Owned by: Federico M Pouzols
Priority: major Milestone: Release 3.5
Component: Documentation Keywords:
Cc: Blocked By: #11064, #11126
Blocking: Tester:

Description (last modified by Federico M Pouzols) (diff)

The documentation of all the traditional remote algorithms (example: ​http://docs.mantidproject.org/nightly/algorithms/Authenticate-v1.html) assumes that the "remote job submission API" is used. When #11126 happens, the documentation needs to be updated. Explain that the algorithms are generic, and state what particular backends/schedulers are supported for now: the Mantid web service API (for Fermi at SNS), and LSF (for SCARF at ISIS).

This concerns the following algorithm rst documentation:

  • AbortRemoteJob
  • Authenticate
  • DownloadRemoteFile
  • QueryAllRemoteJobs
  • QueryRemoteFile
  • QueryRemoteJob
  • StartRemoteTransaction
  • StopRemoteTransaction
  • SubmitRemoteJob
  • UploadRemoteFile

A wiki page that explains the workflow with these algorithms would be convenient too.

Change History

comment:1 Changed 6 years ago by Federico M Pouzols

  • Status changed from new to assigned

comment:2 Changed 6 years ago by Federico M Pouzols

  • Description modified (diff)

comment:3 Changed 5 years ago by Nick Draper

  • Milestone changed from Release 3.4 to Release 3.5

Moved to R3.5 at the R3.4 code freeze

comment:4 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue ​12200

Note: See TracTickets for help on using tickets.