Re #27633

When assigning to a list of outputs when calling the algorithm in
python, the outputs must be specified in the order they are declared,
even if they are optional outputs like IvsLam. This means that if we
want to specify the transmission workspace output we must first specify
IvsLam even if debug is false. Some of the algorithms always output
IvsLam if the name was given whereas others did not. They now always
output it if the name is given.

Note that this means you may now get an error if you don't supply enough
arguments whereas previously it was ok. It is ok if you just specify the
IvsQ output(s) but beyond that we do not know whether the output should
be IvsLam or the transmission, so we require all of them, hence the
error. This is better than it assigning an unexpected output so I think
is ok, and is the only way I can think to do this.

Re #27633

This commit removes unnecessary comments in SaveRMCProfile and SavePDFGui docs

Re: #27774

Re #27825

GSL 1 causes a slighly different but acceptable value.

This commit fixes failing tests for SaveRMCProfileTest, assertions on number of lines were improperly counted.

This commit fixes garbled code resulting from a mistake during merging master
It also removes an in correctly named file that has since been replaced with a correctly spelled one.

This commit creates an algorithm `SaveRMCProfile` to output an ascii file with the format corresponding to a file used by the RMCProfile package. the output file contains only the x and y data from a workspace with a header containing the number of y values in the file on the first line, and on the second line the type of function contained within and a title for the data.

re: #27774

Signed-off-by: Jose Borreguero <borreguero@gmail.com>

Signed-off-by: Jose Borreguero <borreguero@gmail.com>

Signed-off-by: Jose Borreguero <borreguero@gmail.com>

Signed-off-by: Jose Borreguero <borreguero@gmail.com>

Signed-off-by: Jose Borreguero <borreguero@gmail.com>

Fix EnggCalibrateV1 Doc Test

Fix EnggFitTOFFromPeaks doc test

Make EnggCalibrateFull doctests ignore output values

Remove commented out code in LoadStlFactory.h
Remove redundant inline specifier from MeshFileIO and redundant clauses
in switch statements
Edits to two documentation files that are impacted by the addition of the
stl path feature to the environment definition .xml files

The format of the sample environment xml file has been extended to support
loading a .stl file for each environment component. An example spec file
has been created in ISIS/Pearl.xml. This can be used when running the
Algorithm SetSample
Various SampleEnvironmentXXX units have been moved out the Geometry package
into the DataHandling package to facilitate this because they needed to
access the STL loading code in DataHandling
SetSample contains some features for overriding the sample geometry if the
geometry is a CSGObject. This has been sidestepped for mesh geometries.
The methods setId and setMaterial have been moved up to IObject because
it's useful to have them applicable to all objects (CSG, mesh)
Some of the repeated code in SetSample, LoadSampleEnvironment (and now
SampleEnvironmentSpecParser) has been centralised in a new class LoadStlFactory
Also changed container logic so that if there's only one container specified
in the env spec file you don't need to specify it in SetSample
Centralise code relating to scaling mesh vertices and handling of units
into the LoadShape class and rename it MeshFileIO now that SaveStl is also
descended from this class
Move repeated code to choose Ascii or binary STL reader into a factory class

Co-Authored-By: Harrietbrown <49688535+Harrietbrown@users.noreply.github.com>

This creates the framework for a saveRMCProfile algorithm that would be used for saving spectral density data in a format that can be read by RMCProfile.
TODO get propper format of metadata

re: #27774

Parameter to control track resimulation renamed to ResimulateTracksForDifferentWavelengths
Default number of events per point increased from 300 to 1000
Highlighted breaking change to parameter list for MonteCarloAbsorption in release notes
Adjust AbsorbtionShapesTest to accommodate new default value of 1000 for the EventsPerPoint
parameter in MonteCarloAbsorption. Also fix typo in class name

The parameter NumberOfWavelengthPoints is now only required if you are
resimulating tracks for different wavelengths (which is not the default).
Update documentation on MonteCarloAbsorption and related algorithms to
reflect this.

Also updates documentation test to check peaks directly
for modulated structure indices.
Refs #26839

This Commit adds descriptions of different distribution functions to the PDFFourierTransform documentation.

re: #27772

IndexPeaks can be used for both Bragg and Satellite indexing
Refs #27596

The new output files use different delimiters and have an extra line of
metadata that needs to be accounted for.

To avoid polluting the dev-docs with algorithm-specific info and to
avoid storing/updating many image files the Abins development notes
are moved back into Concepts. The fast broadening method is broken
into a separate document to avoid too much wading through plots.

I've added the link back in as the saveNISTDAT_data.nxs file was already in the DocTest data file and had just been removed from the usagedata so this was the simplest thing to do. This file is now in the UsageData

It defaults to 500 bins.
This allows event data to be plotted without rebinning first.
This is a change from before when it would all be in one bin.
It does not change the underlying data that remains in events.

Includes unit test, and doc changes.