hyperspy / exspy

EDS and EELS data analysis with HyperSpy
https://hyperspy.org/exspy
GNU General Public License v3.0
11 stars 10 forks source link

Extend public API and fix documentation #59

Closed ericpre closed 3 months ago

ericpre commented 5 months ago

Add back some functions which were removed when splitting from hyperspy. Some modules and functions that were not to the public API as listed in the API reference have been removed.

Progress of the PR

codecov[bot] commented 5 months ago

Codecov Report

Attention: Patch coverage is 77.01318% with 157 lines in your changes missing coverage. Please review.

Project coverage is 88.62%. Comparing base (3b7425e) to head (9e0d0be). Report is 48 commits behind head on main.

Files with missing lines Patch % Lines
exspy/_misc/eels/tools.py 40.93% 95 Missing and 6 partials :warning:
exspy/_misc/material.py 83.78% 11 Missing and 13 partials :warning:
exspy/_misc/eds/utils.py 92.59% 7 Missing and 9 partials :warning:
...py/_misc/eels/electron_inelastic_mean_free_path.py 59.25% 11 Missing :warning:
exspy/material.py 80.00% 1 Missing :warning:
exspy/misc/eds/utils.py 85.71% 1 Missing :warning:
exspy/misc/eels/tools.py 85.71% 1 Missing :warning:
exspy/utils/__init__.py 80.00% 1 Missing :warning:
exspy/utils/eels.py 83.33% 1 Missing :warning:
Additional details and impacted files ```diff @@ Coverage Diff @@ ## main #59 +/- ## ========================================== + Coverage 88.55% 88.62% +0.06% ========================================== Files 67 76 +9 Lines 7341 7411 +70 Branches 1187 1192 +5 ========================================== + Hits 6501 6568 +67 - Misses 571 574 +3 Partials 269 269 ```

:umbrella: View full report in Codecov by Sentry.
:loudspeaker: Have feedback on the report? Share it here.


🚨 Try these New Features:

CSSFrancis commented 3 months ago

@ericpre I can review this today!

ericpre commented 3 months ago

Thank you @CSSFrancis for the review. I added a shim for the functionalities that have been added to the public API. Do you want to have another look?