LDAR-Sim / LDAR_Sim

MIT License
11 stars 22 forks source link

70-Refactor LDAR-Sim parameters #91

Closed ThomasGalesloot closed 1 year ago

ThomasGalesloot commented 1 year ago

Pull Request Key Information

Reason for change

Reduce user confusion and make LDAR-Sim parameterization more intuitive.

What was changed

The majority of program level parameters have been moved to a new parameter file named virtual_world parameters. There will only exist one virtual world parameters file per simulation set. This will provide clarity on the intended purpose of parameters contained within and enforce the that these parameters cannot be set on a per program basis for valid LDAR-Sim results to be obtained.

Intended Purpose

This changes is aimed at solving the issue of user confusion when dealing with LDAR-Sim parameterization, specifically program level parameters. Many program level parameters are not actually able to be set at the program level as they are overwritten with the values set for the baseline program for all other programs. This is misleading as the parameters being at the program level implies that they can be set per program.

Level of version change required

Major Version Change to 3.0.0

Testing Completed

Manual testing has completed in initial stages. End to End testing was run before updating expected outputs for new parameter version (Commit SHA1 5d5f2e3b7f54e299efd28312add3d58613be7b62) - Only failures were the parameter comparison. E2E_testing_logs_5d5f2e3b7f54e299efd28312add3d58613be7b62.zip

Now after updating End-to-End testing for new parameter version - All test passing. All unit tests are also passing. Testing logs_9c0573ce2f816151869e6f0b4c952d129b045402.zip

All End to End testing and unit testing is passing for SHA1: 52d95c201cb94c1374f77982a1553815c6df3bfd test_results_52d95c201cb94c1374f77982a1553815c6df3bfd.zip

Target Issue

Closes #70

Additional Information

N/A

ThomasGalesloot commented 1 year ago

All testing passing for latest commit: 52d95c201cb94c1374f77982a1553815c6df3bfd. test_results_52d95c201cb94c1374f77982a1553815c6df3bfd.zip