Skip to content

Commit

Permalink
doc clarifications and update, re #10591
Browse files Browse the repository at this point in the history
  • Loading branch information
FedeMPouzols committed Feb 13, 2015
1 parent 1269511 commit b33eb75
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 13 deletions.
Expand Up @@ -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() {

Expand Down Expand Up @@ -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=" +
Expand Down
19 changes: 10 additions & 9 deletions Code/Mantid/docs/source/algorithms/SCARFTomoReconstruction-v1.rst
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit b33eb75

Please sign in to comment.