-
Notifications
You must be signed in to change notification settings - Fork 206
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
user doc update _ eds.rst #3006
base: RELEASE_next_patch
Are you sure you want to change the base?
Conversation
Update python version in readthedocs.yml
Update python version in readthedocs.yml
Fittiing order changed for improved logic. m.fit_background() first which fixes it then m.fit() for the gaussians components. Text revised to match the new order.
@@ -519,7 +519,7 @@ EDS curve fitting | |||
|
|||
The intensity of X-ray lines can be extracted using curve-fitting in HyperSpy. | |||
This example uses an EDS-SEM spectrum of a test material (EDS-TM001) provided | |||
by `BAM <https://www.webshop.bam.de>`_. | |||
by `BAM <http://www.webshop.bam.de>`_. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please keep the https
>>> m.fit_background() | ||
|
||
>>> m.fit() | ||
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
remove unnecessarily added indent
@@ -25,7 +25,7 @@ | |||
# When running setup.py the ".dev" string will be replaced (if possible) | |||
# by the output of "git describe" if git is available or the git | |||
# hash if .git is present. | |||
version = "1.7.2.dev0" | |||
version = "1.8.0.dev0" |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
RELEASE_next_patch should stay on 1.7.2.dev0
This and the next change look like you had started out from RELEASE_next_minor, which would explain the errors you got when trying to PR into RELEASE_next_patch
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Hi, yes, the only branch I could fork was the RELEASE_next_minor, the other were not listed, how to start out from the the RELEASE_next_patch instead? *first time on Github
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There are different ways of doing it, but here are the main steps:
- Checkout the branch off
RELEASE_next_patch
, for example:git checkout -b my_new_branch RELEASE_next_patch
- commit your changes
- push your changes to your own repository (should be
https://github.com/OliDG/hyperspy
) - on github, make the pull request to
https://github.com/hyperspy/hyperspy
from your branch inhttps://github.com/OliDG/hyperspy
Usually, the term fork is used in the context of repository, not branch.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
If you have issue with this, for this time, you can continue to commit and push to this branch and we can "clean" the branch before merging, once we are happy with the content of this PR.
>>> m.fit_background() | ||
|
||
>>> m.fit() | ||
The width of the X-ray lines is defined from the energy resolution (FWHM at |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The width of the X-ray lines is defined from the energy resolution (FWHM at | |
The widths of the X-ray lines are defined from the energy resolution (FWHM at |
If you are at it, could you once proofread the whole |
Codecov Report
@@ Coverage Diff @@
## RELEASE_next_patch #3006 +/- ##
===================================================
Coverage 80.80% 80.80%
===================================================
Files 209 209
Lines 32706 32706
Branches 7329 7329
===================================================
Hits 26428 26428
Misses 4512 4512
Partials 1766 1766
Help us with your feedback. Take ten seconds to tell us how you rate us. Have a feature suggestion? Share it here. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Fitting background independently is not always necessary and I guess that this is the reason why in the current version, it came after and says that the "background fitting can be improved with".
In my opinion, the changes of this PR are more or less equivalent, except that now it implies that one need to fit the background first and then do the rest of the fit. For example, doing the fit without fitting background independently can work well for many cases.
In its current form and in its PR, this is vague and lack details on what are the consequences of the fitting order and its corresponding logic. Can you try to improve these aspects?
Description of the change
User guide update _ eds.rst
Model fitting sequence changed in the user docs for improved logic.
First we run the m.fit_background() as it fixes the background components, then m.fit() is launched for the Gaussian components fitting. Their A values depend on the background and fitting the background after the m.fit() do not change the A component values.
Documentation text revised to match the new order.
Progress of the PR
upcoming_changes
folder (seeupcoming_changes/README.rst
),readthedocs
doc build of this PR (link in github checks)