Flexible Time Slicing: Supporting Non-Integer Period Divisions

[ktactac-ornl]

Description of work:

The IS wanted the division of time slice to work with non integer number of sliced periods. For e.g. timeslice=1; total period = 9.2, in which case there will be 9 sliced periods of 1 and the last time slice would be 0.2 long. The 0.2 leftover should be reduced too.

• Updates TimeSeries creation used for slices
• Removes integer validation of period / interval
• Adds non-integer test case
• Updates user documentation to this change

Check all that apply:

• added release notes (if not, provide an explanation in the work description)
• updated documentation
• Source added/refactored
• Added unit tests
• Added integration tests
• Verified that tests requiring the /SNS and /HFIR filesystems pass without fail

References:

• Links to IBM EWM items: 8995: [DRTSANS] Flexible Time Slicing: Supporting Non-Integer Period Divisions
• Links to related issues or pull requests:
  This story is related to a previous defects when the rounding up errors in time slicing cause errors - 8091: [DRTSANS] Periodic slicing error while offset is introduced from the start

Manual test for the reviewer

Check list for the reviewer

• release notes updated, or an explanation is provided as to why release notes are unnecessary
• best software practices
  • clearly named variables (better to be verbose in variable names)
  • code comments explaining the intent of code blocks
• All the tests are passing
• The documentation is up to date
• code comments added when explaining intent

Execution of tests requiring the /SNS and /HFIR filesystems

It is strongly encouraged that the reviewer runs the following tests in their local machine
because these tests are not run by the GitLab CI. It is assumed that the reviewer has the /SNS and /HFIR filesystems
remotely mounted in their machine.

cd /path/to/my/local/drtsans/repo/
git fetch origin merge-requests/<MERGE_REQUEST_NUMBER>/head:mr<MERGE_REQUEST_NUMBER>
git switch mr<MERGE_REQUEST_NUMBER>
conda activate <my_drtsans_dev_environment>
pytest -m mount_eqsans ./tests/unit/ ./tests/integration/

In the above code snippet, substitute <MERGE_REQUEST_NUMBER> for the actual merge request number. Also substitute
<my_drtsans_dev_environment> with the name of the conda environment you use for development. It is critical that
you have installed the repo in this conda environment in editable mode with pip install -e . or conda develop .

[codecov-commenter]

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 86.12%. Comparing base (d88ea02) to head (a7232a4).
Report is 17 commits behind head on next.

Additional details and impacted files

@@            Coverage Diff             @@
##             next     #999      +/-   ##
==========================================
+ Coverage   86.09%   86.12%   +0.02%     
==========================================
  Files          97       97              
  Lines       10742    10758      +16     
==========================================
+ Hits         9248     9265      +17     
+ Misses       1494     1493       -1     

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.