Check adherence to algorithm property naming conventions

[Russell Taylor]

As described at http://www.mantidproject.org/Mantid_Standards

Correct deviations from this.
In particular, there are places where an underscore is being used. At the time of writing this happens (as far as I could find) in:

• LoadEventNexus
• SumRowColumn
• SaveNXSPE
• ConvertToQ3DdE
• SimulateMDD

A full list has been attached in the txt file on this ticket

Once you are finished send an email with all of the changes ot Nick Draper for inclusion in the next release notes.

[Russell Taylor]

A duplicate ticket (#3877) was created under which the LoadEventNexus names were fixed. The others remain.

[Karl Palmen]

Should the convention apply to properties that are referred to in the outside world by a lower-case character in either the Latin or Greek alphabets?

Forcing such properties to conform to begin with capital letters could confuse or annoy customers. If such properties are not ammended, then the conventions need ammending to include such an exception.

[Karl Palmen]

The properties of LoadEventNexus appear to have been fixed as documented in http://www.mantidproject.org/LoadEventNexus

[Karl Palmen]

There is no reference to any properties in LoadSNSEventNexus. It just calls LoadEventNexus.

[Karl Palmen]

According to the wiki http://www.mantidproject.org/CatalogMyDataSearch , CatalogMyDataSearch is no "isValid" property and has code in login.h/.cpp . According to the code I have, an algorithm cMyDataSearch does have such a property in MyDataSearch.cpp .

[Karl Palmen]

kernel_exports.cpp lists a large number of lower case properties missed out of attachment Wrong_Alg_Names.txt .

[Karl Palmen]

Changes to property names I have made for this ticket.

[Karl Palmen]

Changed properties as specified in recent attachment.

The (a, b, c, alpha, beta, gamma) properties are unchanged because of algorithm convention.

Property inFilename not found in code or wiki.

[Karl Palmen]

local commit to enable pull re #3870

Changeset: b5eaa5a25006913125b4bd576481e34eb8ccb710

[Karl Palmen]

Changed algorithm properties and specified in recently attached file re #3870

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

Changeset: e2a2059c276912e1a63813700a7fa0649bee663f

[Andrei Savici]

Note: check if any of the changes affect the scripts shipped with Mantid. See for example the change in Changeset: fabd7dc9b224470af899808c8f207282aaa74dc0, for ticket #3208.

[Karl Palmen]

I've made such checks with Astrogrep and find no others besides the one you changed, except also "psi=" needs changing to "Psi=" in the line you changed.

[Karl Palmen]

Update property names in python files re #3870

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

Changeset: 7f0d204ee69f20bcf7d4b293726143e61a345bcd

[Karl Palmen]

Update property names in python files re #3870

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

Changeset: 7f0d204ee69f20bcf7d4b293726143e61a345bcd

[Nick Draper]

tested using this script:

import re

def RemoveVersion(algName):
	m = re.search('\w+', algName)
	return m.group(0)
	
def FirstCapital(algName):
	m = re.search('^[A-Z].*', algName)
	if m is None:
		return "The first letter must be a capital.\n"
	else:
		return ""
		
def IllegalCaracters(algName):
	m = re.search('[\-\_\(\)\[\]]', algName)
	if m is None:
		return ""
	else:
		return "Contains illegal characters.\n"
	

with open('c:/mantid/algnames.txt', 'r') as f:
	algNames = f.readlines()
f.closed

for algName in algNames:
	errorMessage=""
	algName = RemoveVersion(algName)
	errorMessage+=FirstCapital(algName)
	errorMessage+=IllegalCaracters(algName)
	alg=mtd.createAlgorithm(algName)
	if errorMessage <>"": print algName, errorMessage
	for prop in alg.getProperties():
		propError = ""
		propError+=FirstCapital(algName)
		propError+=IllegalCaracters(algName)
		if propError <>"": print algName, prop.name, propError

[Stuart Campbell]

This ticket has been transferred to github issue ​4717