From b33eb756609fb4b99cf61d56fbedc117fbe51ecd Mon Sep 17 00:00:00 2001 From: Federico Montesino Pouzols Date: Fri, 13 Feb 2015 11:51:15 +0000 Subject: [PATCH] doc clarifications and update, re #10591 --- .../src/SCARFTomoReconstruction.cpp | 8 ++++---- .../algorithms/SCARFTomoReconstruction-v1.rst | 19 ++++++++++--------- 2 files changed, 14 insertions(+), 13 deletions(-) diff --git a/Code/Mantid/Framework/RemoteAlgorithms/src/SCARFTomoReconstruction.cpp b/Code/Mantid/Framework/RemoteAlgorithms/src/SCARFTomoReconstruction.cpp index a3208d647a4a..a702f2b63c9b 100644 --- a/Code/Mantid/Framework/RemoteAlgorithms/src/SCARFTomoReconstruction.cpp +++ b/Code/Mantid/Framework/RemoteAlgorithms/src/SCARFTomoReconstruction.cpp @@ -199,7 +199,7 @@ SCARFTomoReconstruction::Action::Type SCARFTomoReconstruction::getAction() { * specific methods. * * The implementation of the more specific methods is based on: - * Mantid::Kernel::InternetHelper and Mantid::RemoteAlgorithms::SimpleJSON? + * Mantid::Kernel::InternetHelper. */ void SCARFTomoReconstruction::exec() { @@ -337,9 +337,9 @@ void SCARFTomoReconstruction::doLogin(const std::string &username, auto it = std::find(res.begin(), res.end(), m_SCARFComputeResource); if (res.end() == it) throw std::runtime_error(std::string("Failed to find a compute resource " - "for " + m_SCARFComputeResource + " (facility: " + - ConfigService::Instance().getFacility().name() + - ").")); + "for " + m_SCARFComputeResource + " (facility: " + + ConfigService::Instance().getFacility().name() + + ").")); InternetHelper session; std::string httpsURL = SCARFLoginBaseURL + SCARFLoginPath + "?username=" + diff --git a/Code/Mantid/docs/source/algorithms/SCARFTomoReconstruction-v1.rst b/Code/Mantid/docs/source/algorithms/SCARFTomoReconstruction-v1.rst index 7ba347635142..b8605e09efe8 100644 --- a/Code/Mantid/docs/source/algorithms/SCARFTomoReconstruction-v1.rst +++ b/Code/Mantid/docs/source/algorithms/SCARFTomoReconstruction-v1.rst @@ -9,11 +9,12 @@ Description ----------- -Algorithm to control tomographic reconstruction jobs running on the -SCARF computer cluster at RAL, STFC (see http://www.scarf.rl.ac.uk/ -for more information). This algorithm can be used to log in and out -from the cluster, and to initiate, query the status of, or cancel a -job. +Algorithm to control jobs running on the SCARF computer cluster at +RAL, STFC (see http://www.scarf.rl.ac.uk/ for more information). This +algorithm can be used to log in and out from the cluster, and to +initiate, query the status of, or cancel a job. It has been introduced +to control tomographic reconstruction jobs but in principle it can be +used for any other task. In a typical use case or session you would use the algorithm a first time to login (for which you need to select the 'LogIn' action and set @@ -22,10 +23,10 @@ algorithm again several times, to submit jobs (setting the action 'SubmitJob'), query the status of the jobs running on the computer cluster (setting the action to 'JobStatus' or 'JobStatusByID'), cancel jobs (setting the action 'CancelJob') and log out from the cluster -(action 'LogOut'). After logging out, subsequent submit or status -queries will fail with an informative message. Note that the server -will log out users every undetermined amount of time, which depends on -server settings. +(action 'LogOut'). You can also upload and download files. After +logging out, subsequent submit or status queries will fail with an +informative message. Note that the server will log out users every +undetermined amount of time, which depends on server settings. In principle, in a simple use case, the same username will be used in all the calls to this algorithm. This means that you type in the