Ticket #5627 (closed: fixed)

Opened 8 years ago

Last modified 5 years ago

Get rid of LoadRaw1, LoadRaw2 & LoadISISNexus1

Reported by: Martyn Gigg Owned by: Russell Taylor
Priority: major Milestone: Release 2.5
Component: Mantid Keywords:
Cc: anders.markvardsen@… Blocked By:
Blocking: Tester: Martyn Gigg

Description

As far as I know, and I'm fairly confident, these algorithms are not used by anyone. They're very out of date & are causing a maintenance headache so I think they should be deleted.

Change History

comment:1 Changed 8 years ago by Nick Draper

  • Status changed from new to assigned
  • Owner set to Anyone

comment:2 Changed 8 years ago by Nick Draper

  • Milestone changed from Release 2.2 to Release 2.3

Moved at the end of release 2.2

comment:3 Changed 8 years ago by Nick Draper

  • Milestone changed from Release 2.3 to Release 2.4

Moved to milestone 2.4

comment:4 Changed 8 years ago by Karl Palmen

  • Owner changed from Anyone to Karl Palmen

comment:5 Changed 8 years ago by Karl Palmen

  • Status changed from assigned to accepted

comment:6 Changed 8 years ago by Karl Palmen

LoadRaw1 and LoadISISNexus1 are not found in DataHandling and no reference to them found in any code. LoadRaw2 is found.

comment:7 Changed 8 years ago by Karl Palmen

The following, besides LoadRaw2 itself and its unit test use (or refer to) LoadRaw2.

UnwrapTest

ManagedRawFileWorkspace2DTest

XMLlogfileTest

Also LoadRawHelper has a function, which according to comments is needed only for LoadRaw2.

comment:8 Changed 8 years ago by Karl Palmen

None of these three algorithms are found in the wiki.

comment:9 Changed 8 years ago by Karl Palmen

LoadRaw2 does not appear to be available in the Mantidplot algorithm menu even within its category of DataHandling\Raw. May this is because only the most recent version is shown (LoadRaw3) of an algorithm of any given name (LoadRaw).

comment:10 Changed 8 years ago by Karl Palmen

Unwrap whose unit test uses LoadRaw2 has been marked as deprecated.

comment:11 Changed 8 years ago by Karl Palmen

  • Cc anders.markvardsen@… added

comment:12 Changed 8 years ago by Karl Palmen

Modified two unit tests to use LoadRaw3 instead of LoadRaw2 re #5627

UnwrapTest.h and ManagedRawFileWorkspace2DTest.h were modified and worked. XMLlogfileTest.h could not so modified, because running it would then cause Mantid to crash.

Changeset: 9953d1481bb5c70c9a8e5d346afa00b6c2e6f7ab

comment:13 Changed 8 years ago by Karl Palmen

Both the tests of XMLlogfileTest have the comment

  // LoadRaw2 uses XMLlogfile to populate its parameter map. Hence the test here simply
  // checks that this is done ok

If LoadRaw3 were to also use XMLlogfile for this purpose separate test would or should exist for this. Hence XMLlogfileTest can be removed when LoadRaw2 is removed.

comment:14 Changed 8 years ago by Karl Palmen

I've run Mantid having removed LoadRaw2. I see in the Algorithms menu in DataHanding\Raw\LoadRaw v3 that a LoadRaw v1 exists but not LoadRaw v2. I think this is because LoadRaw.h returns a version number of 1. Is this correct?

Therefore the existence of LoadRaw v1 in the Algorithms menu can't be used to fail this ticket when testing.

A similar issues applies to LoadISISNexus causing LoadISISNexus v1 to appear in the Algorithms menu in DataHandling\Nexus\LoadISISNexus v2 .

comment:15 Changed 8 years ago by Karl Palmen

Removed LoadRaw2 and its unit test and XMLlogfileTest re #5627

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 8af0947a4349753bc42d92a11e85fdb5a6e43859

comment:16 Changed 8 years ago by Karl Palmen

Revert "Removed LoadRaw2 and its unit test and XMLlogfileTest re #5627"

This reverts commit 8af0947a4349753bc42d92a11e85fdb5a6e43859.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: f318cdd6fc1bbf46b2b6eb44348af9d1b6fc4612

comment:17 Changed 8 years ago by Karl Palmen

The revert was due to failure of VanillaPython. Also Peter Peterson pointed out there was other code that explicitly uses LoadRaw version 2 (either out of reach of my Microsoft Visual Studio or not using the string 'LoadRaw2').

Also it seems that LoadRaw might be LoadRaw1 rather than a generic LoadRaw, likewise with LoadISISNexus.

comment:18 Changed 8 years ago by Karl Palmen

  • Status changed from accepted to assigned

I'll cease work on this ticket till I get further help.

comment:19 Changed 8 years ago by Karl Palmen

Ideally the unit tests should not call a specific version of LoadRaw (or LoadISISNexus), but obtain the most recent version. This can be done by

IAlgorithm_sptr loader = AlgorithmFactory::Instance().create("LoadRaw");

for LoadRaw.

comment:20 Changed 8 years ago by Karl Palmen

  • Status changed from assigned to accepted

comment:21 Changed 8 years ago by Karl Palmen

My first attempt of using

IAlgorithm_sptr loader = AlgorithmFactory::Instance().create("LoadRaw");

in UnwrapTest lead to a crash. I may try again when I return from leave.

comment:22 Changed 8 years ago by Karl Palmen

Modified two unit tests to use LoadRaw3 instead of LoadRaw2 re #5627

UnwrapTest.h and ManagedRawFileWorkspace2DTest.h were modified and worked. XMLlogfileTest.h could not so modified, because running it would then cause Mantid to crash.

Changeset: 9953d1481bb5c70c9a8e5d346afa00b6c2e6f7ab

comment:23 Changed 8 years ago by Karl Palmen

Removed LoadRaw2 and its unit test and XMLlogfileTest re #5627

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: 8af0947a4349753bc42d92a11e85fdb5a6e43859

comment:24 Changed 8 years ago by Karl Palmen

Revert "Removed LoadRaw2 and its unit test and XMLlogfileTest re #5627"

This reverts commit 8af0947a4349753bc42d92a11e85fdb5a6e43859.

Signed-off-by: Karl Palmen <karl.palmen@…>

Changeset: f318cdd6fc1bbf46b2b6eb44348af9d1b6fc4612

comment:25 Changed 8 years ago by Karl Palmen

  • Milestone changed from Release 2.4 to Release 2.5

comment:26 Changed 8 years ago by Russell Taylor

Any chance this can be picked up again soon? I'm finding myself once more in the situation of having to (pointlessly) maintain these algorithms on API changes, including spotting one thing that was certainly broken by not picked up by any automated test. I might be able to pick it up myself if there's not enough time over there.

comment:27 Changed 8 years ago by Karl Palmen

  • Cc taylorrj@… added
  • Status changed from accepted to assigned

There's not much chance of me picking it up again, because I'm not in a position to do all the necessary tests. I'd appreciate it if Russell or some one else in a better position. pick this one up.

comment:28 Changed 8 years ago by Russell Taylor

  • Cc taylorrj@… removed
  • Status changed from assigned to accepted
  • Owner changed from Karl Palmen to Russell Taylor

comment:29 Changed 8 years ago by Russell Taylor

Re #5627. Remove LoadISISNexus version 1.

A stub has been left that always fails and informs the user that they should use version 2.

Changeset: cb97660e9fec1afab04b6ec619bb90a670939f4f

comment:30 Changed 8 years ago by Russell Taylor

Re #5627. Remove LoadRaw version 1.

A stub has been left that always fails and informs the user that they should use version 3. This will break some unit tests - they will be fixed next.

Changeset: a8526a4afe0957dbecfa34909e022a3c03006a46

comment:31 Changed 8 years ago by Russell Taylor

Re #5627. Remove unnecessary inclusions of LoadRaw.h

Changeset: cca08afeff53b61e9873b4b022494c9972b4c087

comment:32 Changed 8 years ago by Russell Taylor

Re #5627. Replace unit test that used LoadRaw V1

...with one that doesn't load real data.

Changeset: d5cfeeb3212e51872e6c46b1aa92daf8f0fe462a

comment:33 Changed 8 years ago by Russell Taylor

Re #5627. Remove LoadRaw version 2.

A stub has been left that always fails and informs the user that they should use version 3.

Changeset: 3f5eb1014d6fe8e6fec1f8111fbba7cc142010e5

comment:34 Changed 8 years ago by Russell Taylor

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

Tester: It all happened with the commits from comment:29 onwards. Branch is feature/5627_remove_loadraw_V1andV2.

Testing is easy - look at the meagre remnants of the 3 removed algorithms and make sure that no automated tests are failing because they're gone. Try running them both from the algorithm list in MantidPlot (the tree, you can't access old versions by typing the names) and from python. The algorithm will fail and you will see a message explaining that it's been removed.

comment:35 Changed 8 years ago by Martyn Gigg

  • Status changed from verify to verifying
  • Tester set to Martyn Gigg

comment:36 Changed 8 years ago by Russell Taylor

Re #5627. Remove LoadISISNexus version 1.

A stub has been left that always fails and informs the user that they should use version 2.

Changeset: cb97660e9fec1afab04b6ec619bb90a670939f4f

comment:37 Changed 8 years ago by Russell Taylor

Re #5627. Remove LoadRaw version 1.

A stub has been left that always fails and informs the user that they should use version 3. This will break some unit tests - they will be fixed next.

Changeset: a8526a4afe0957dbecfa34909e022a3c03006a46

comment:38 Changed 8 years ago by Russell Taylor

Re #5627. Remove unnecessary inclusions of LoadRaw.h

Changeset: cca08afeff53b61e9873b4b022494c9972b4c087

comment:39 Changed 8 years ago by Russell Taylor

Re #5627. Replace unit test that used LoadRaw V1

...with one that doesn't load real data.

Changeset: d5cfeeb3212e51872e6c46b1aa92daf8f0fe462a

comment:40 Changed 8 years ago by Russell Taylor

Re #5627. Remove LoadRaw version 2.

A stub has been left that always fails and informs the user that they should use version 3.

Changeset: 3f5eb1014d6fe8e6fec1f8111fbba7cc142010e5

comment:41 Changed 8 years ago by Russell Taylor

Re #5627. A few places that include LoadRaw.h unnecessarily.

Changeset: 543ec40a282396bd732fc4a4bf70de0bcd3dc6b4

comment:42 Changed 8 years ago by Russell Taylor

Re #5627. A few places that include LoadRaw.h unnecessarily.

Changeset: 543ec40a282396bd732fc4a4bf70de0bcd3dc6b4

comment:43 Changed 8 years ago by Russell Taylor

Re #5627. Remove LoadISISNexus version 1.

A stub has been left that always fails and informs the user that they should use version 2.

Changeset: cb97660e9fec1afab04b6ec619bb90a670939f4f

comment:44 Changed 8 years ago by Russell Taylor

Re #5627. Remove LoadRaw version 1.

A stub has been left that always fails and informs the user that they should use version 3. This will break some unit tests - they will be fixed next.

Changeset: a8526a4afe0957dbecfa34909e022a3c03006a46

comment:45 Changed 8 years ago by Russell Taylor

Re #5627. Remove unnecessary inclusions of LoadRaw.h

Changeset: cca08afeff53b61e9873b4b022494c9972b4c087

comment:46 Changed 8 years ago by Russell Taylor

Re #5627. Replace unit test that used LoadRaw V1

...with one that doesn't load real data.

Changeset: d5cfeeb3212e51872e6c46b1aa92daf8f0fe462a

comment:47 Changed 8 years ago by Russell Taylor

Re #5627. Remove LoadRaw version 2.

A stub has been left that always fails and informs the user that they should use version 3.

Changeset: 3f5eb1014d6fe8e6fec1f8111fbba7cc142010e5

comment:48 Changed 8 years ago by Martyn Gigg

  • Status changed from verifying to closed

comment:49 Changed 8 years ago by Russell Taylor

Re #5627. A few places that include LoadRaw.h unnecessarily.

Changeset: 543ec40a282396bd732fc4a4bf70de0bcd3dc6b4

comment:50 Changed 8 years ago by Russell Taylor

Re #5627. Remove LoadISISNexus version 1.

A stub has been left that always fails and informs the user that they should use version 2.

Changeset: cb97660e9fec1afab04b6ec619bb90a670939f4f

comment:51 Changed 8 years ago by Russell Taylor

Re #5627. Remove LoadRaw version 1.

A stub has been left that always fails and informs the user that they should use version 3. This will break some unit tests - they will be fixed next.

Changeset: a8526a4afe0957dbecfa34909e022a3c03006a46

comment:52 Changed 8 years ago by Russell Taylor

Re #5627. Remove unnecessary inclusions of LoadRaw.h

Changeset: cca08afeff53b61e9873b4b022494c9972b4c087

comment:53 Changed 8 years ago by Russell Taylor

Re #5627. Replace unit test that used LoadRaw V1

...with one that doesn't load real data.

Changeset: d5cfeeb3212e51872e6c46b1aa92daf8f0fe462a

comment:54 Changed 8 years ago by Russell Taylor

Re #5627. Remove LoadRaw version 2.

A stub has been left that always fails and informs the user that they should use version 3.

Changeset: 3f5eb1014d6fe8e6fec1f8111fbba7cc142010e5

comment:55 Changed 8 years ago by Russell Taylor

Re #5627. A few places that include LoadRaw.h unnecessarily.

Changeset: 543ec40a282396bd732fc4a4bf70de0bcd3dc6b4

comment:56 Changed 8 years ago by Russell Taylor

Re #5627. Remove LoadISISNexus version 1.

A stub has been left that always fails and informs the user that they should use version 2.

Changeset: cb97660e9fec1afab04b6ec619bb90a670939f4f

comment:57 Changed 8 years ago by Russell Taylor

Re #5627. Remove LoadRaw version 1.

A stub has been left that always fails and informs the user that they should use version 3. This will break some unit tests - they will be fixed next.

Changeset: a8526a4afe0957dbecfa34909e022a3c03006a46

comment:58 Changed 8 years ago by Russell Taylor

Re #5627. Remove unnecessary inclusions of LoadRaw.h

Changeset: cca08afeff53b61e9873b4b022494c9972b4c087

comment:59 Changed 8 years ago by Russell Taylor

Re #5627. Replace unit test that used LoadRaw V1

...with one that doesn't load real data.

Changeset: d5cfeeb3212e51872e6c46b1aa92daf8f0fe462a

comment:60 Changed 8 years ago by Russell Taylor

Re #5627. Remove LoadRaw version 2.

A stub has been left that always fails and informs the user that they should use version 3.

Changeset: 3f5eb1014d6fe8e6fec1f8111fbba7cc142010e5

comment:61 Changed 8 years ago by Russell Taylor

Re #5627. A few places that include LoadRaw.h unnecessarily.

Changeset: 543ec40a282396bd732fc4a4bf70de0bcd3dc6b4

comment:62 Changed 7 years ago by Russell Taylor

Re #5627. Remove LoadISISNexus version 1.

A stub has been left that always fails and informs the user that they should use version 2.

Changeset: cb97660e9fec1afab04b6ec619bb90a670939f4f

comment:63 Changed 7 years ago by Russell Taylor

Re #5627. Remove LoadRaw version 1.

A stub has been left that always fails and informs the user that they should use version 3. This will break some unit tests - they will be fixed next.

Changeset: a8526a4afe0957dbecfa34909e022a3c03006a46

comment:64 Changed 7 years ago by Russell Taylor

Re #5627. Remove unnecessary inclusions of LoadRaw.h

Changeset: cca08afeff53b61e9873b4b022494c9972b4c087

comment:65 Changed 7 years ago by Russell Taylor

Re #5627. Replace unit test that used LoadRaw V1

...with one that doesn't load real data.

Changeset: d5cfeeb3212e51872e6c46b1aa92daf8f0fe462a

comment:66 Changed 7 years ago by Russell Taylor

Re #5627. Remove LoadRaw version 2.

A stub has been left that always fails and informs the user that they should use version 3.

Changeset: 3f5eb1014d6fe8e6fec1f8111fbba7cc142010e5

comment:67 Changed 7 years ago by Russell Taylor

Re #5627. A few places that include LoadRaw.h unnecessarily.

Changeset: 543ec40a282396bd732fc4a4bf70de0bcd3dc6b4

comment:68 Changed 7 years ago by Russell Taylor

Re #5627. Remove LoadISISNexus version 1.

A stub has been left that always fails and informs the user that they should use version 2.

Changeset: cb97660e9fec1afab04b6ec619bb90a670939f4f

comment:69 Changed 7 years ago by Russell Taylor

Re #5627. Remove LoadRaw version 1.

A stub has been left that always fails and informs the user that they should use version 3. This will break some unit tests - they will be fixed next.

Changeset: a8526a4afe0957dbecfa34909e022a3c03006a46

comment:70 Changed 7 years ago by Russell Taylor

Re #5627. Remove unnecessary inclusions of LoadRaw.h

Changeset: cca08afeff53b61e9873b4b022494c9972b4c087

comment:71 Changed 7 years ago by Russell Taylor

Re #5627. Replace unit test that used LoadRaw V1

...with one that doesn't load real data.

Changeset: d5cfeeb3212e51872e6c46b1aa92daf8f0fe462a

comment:72 Changed 7 years ago by Russell Taylor

Re #5627. Remove LoadRaw version 2.

A stub has been left that always fails and informs the user that they should use version 3.

Changeset: 3f5eb1014d6fe8e6fec1f8111fbba7cc142010e5

comment:73 Changed 7 years ago by Russell Taylor

Re #5627. A few places that include LoadRaw.h unnecessarily.

Changeset: 543ec40a282396bd732fc4a4bf70de0bcd3dc6b4

comment:74 Changed 5 years ago by Stuart Campbell

This ticket has been transferred to github issue 6473

Note: See TracTickets for help on using tickets.