Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add rsciio.set_log_level to set the logging level #192

Merged
merged 3 commits into from
Dec 6, 2023

Conversation

ericpre
Copy link
Member

@ericpre ericpre commented Dec 2, 2023

Closes #69.

Progress of the PR

  • Add rsciio.set_log_level,
  • update docstring (if appropriate),
  • update user guide (if appropriate),
  • add a changelog entry in the upcoming_changes folder (see upcoming_changes/README.rst),
  • Check formatting of the changelog entry (and eventual user guide changes) in the docs/readthedocs.org:rosettasciio build of this PR (link in github checks)
  • add tests,
  • ready for review.

Minimal example of the bug fix or the new feature

import rsciio
rsciio.set_log_level('INFO')

Copy link

codecov bot commented Dec 2, 2023

Codecov Report

All modified and coverable lines are covered by tests ✅

Comparison is base (db3ca53) 86.17% compared to head (2dfd093) 86.16%.

Additional details and impacted files
@@            Coverage Diff             @@
##             main     #192      +/-   ##
==========================================
- Coverage   86.17%   86.16%   -0.02%     
==========================================
  Files          82       82              
  Lines       10475    10503      +28     
  Branches     2275     2276       +1     
==========================================
+ Hits         9027     9050      +23     
- Misses        931      936       +5     
  Partials      517      517              

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

@ericpre ericpre added this to the v0.3 milestone Dec 2, 2023
@ericpre ericpre requested a review from jlaehne December 2, 2023 23:17
@@ -69,4 +69,8 @@ for reading/writing of data files:
* `Kikuchipy <https://kikuchipy.org>`_: Processing, simulating and analyzing
electron backscatter diffraction (EBSD) patterns in Python
* `PyXem <https://pyxem.readthedocs.io>`_: An open-source Python library for
multi-dimensional diffraction microscopy.
multi-dimensional diffraction microscopy.
* `exSpy <https://hyperspy.org/exspy/>`_: Analysis of X-rays Energy Dispersive
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
* `exSpy <https://hyperspy.org/exspy/>`_: Analysis of X-rays Energy Dispersive
* `exSpy <https://hyperspy.org/exspy/>`_: Analysis of Energy Dispersive X-ray

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As both are used and valid, I simply removed the "s". I usually prefer the X-ray EDS because it is consistent with EELS and it is consistent with our use of EDS, as opposed to EDX.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Well, I have seen either of the abbreviations EDS/EDX for "Energy Dispersive X-ray Spectroscopy" (11.5 M hits on google) and had not come across putting the "X-ray" first so far (125k hits on google) .

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is used in the Williams & Carter book (but also in reference paper by Zaluzec or Watanabe), which I use most of the times as reference for this topic and I guess this is why I tend to use this wording.

@jlaehne jlaehne merged commit 2fc162b into hyperspy:main Dec 6, 2023
30 of 31 checks passed
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

set_log_level for rosettasciio is needed
2 participants