Fix error when reading pts file with frame_list, frame_start_index (was PR #67)

[nem1234]

Description of the change

• Bugfix : error when reading JEOL .pts file with un-ordered frame list
• Bugfix : error when length of frame_start_index is smaller than sweep count
• Revise warning message
• Add test for frame list, frame_shift and frame_start_index
• Add test for broken asw file
• Add test for SEM data

Progress of the PR

• Change implemented (can be split into several points),
• update docstring (if appropriate),
• update user guide (if appropriate),
• add an changelog entry in the upcoming_changes folder (see upcoming_changes/README.rst),
• Check formatting changelog entry in the readthedocs doc build of this PR (link in github checks)
• add tests,
• ready for review.

Minimal example of the bug fix or the new feature

s = hs.load("file.pts", frame_list=[1,3])
frame_start_index = s.original_metadata.jeol_pts_frame_start_index
s = hs.load("file.pts", frame_list=[5,2], frame_start_index=frame_start_index)

[codecov]

Codecov Report

Base: 83.52% // Head: 84.11% // Increases project coverage by +0.58% 🎉

Coverage data is based on head (d222c57) compared to base (055822e).
Patch coverage: 100.00% of modified lines in pull request are covered.

Additional details and impacted files

@@            Coverage Diff             @@
##             main      #68      +/-   ##
==========================================
+ Coverage   83.52%   84.11%   +0.58%     
==========================================
  Files          49       56       +7     
  Lines        8390     8411      +21     
  Branches     1893     1890       -3     
==========================================
+ Hits         7008     7075      +67     
+ Misses        909      877      -32     
+ Partials      473      459      -14     

Impacted Files	Coverage Δ
rsciio/jeol/api.py	99.13% <100.00%> (+12.17%)	⬆️
rsciio/netcdf/api.py
rsciio/phenom/api.py
rsciio/protochips/api.py
rsciio/ripple/api.py
rsciio/nexus/api.py
rsciio/prz/api.py
rsciio/phenom/__init__.py	100.00% <0.00%> (ø)
rsciio/ripple/__init__.py	100.00% <0.00%> (ø)
rsciio/netcdf/__init__.py	100.00% <0.00%> (ø)
... and 11 more

Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here.

☔ View full report at Codecov.
📢 Do you have feedback about the report comment? Let us know in this issue.

[jlaehne]

Continuation of #67

[ericpre]

It looks good.

Do you want to add a release note mentioning the following?

• Bugfix : error when reading JEOL .pts file with un-ordered frame list
• Bugfix : error when length of frame_start_index is smaller than sweep count

[nem1234]

Thank you.
This error seems very rare cases, so I don't think adding release note is needed.

By the way, if it is needed, should I write issue before adding upcoming_changes?
Is unnumbered log allowed?

[ericpre]

Based on my experience, release notes are useful even for the most minor changes/bug fix, as it is only useful for users but also for ourselves in the future and developers of other libraries.

To add a release note, you just need to add a file in the upcoming_changes folder with the correct name (PR or issue number and type of changes) and then towncrier will process the entry automatically (add the release note in the right place and add create the hyperlink).

[nem1234]

Ok, I put 68.bugfix.rst into upcoming_change directory