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

New tutorials for hextof #518

Merged
merged 4 commits into from
Nov 21, 2024
Merged

New tutorials for hextof #518

merged 4 commits into from
Nov 21, 2024

Conversation

kutnyakhov
Copy link
Collaborator

Three more tutorials for HEXTOF using new W(110) data sets from the public beamtime folder or also from Zenodo (https://zenodo.org/records/12609441):

@coveralls
Copy link
Collaborator

coveralls commented Nov 18, 2024

Pull Request Test Coverage Report for Build 11940522307

Details

  • 0 of 0 changed or added relevant lines in 0 files are covered.
  • 165 unchanged lines in 7 files lost coverage.
  • Overall coverage decreased (-0.08%) to 91.888%

Files with Coverage Reduction New Missed Lines %
sed/io/nexus.py 1 88.89%
sed/loader/mpes/loader.py 5 86.06%
sed/core/dfops.py 8 84.08%
sed/calibrator/momentum.py 18 86.96%
sed/loader/sxp/loader.py 34 83.99%
sed/calibrator/energy.py 39 92.35%
sed/core/processor.py 60 86.32%
Totals Coverage Status
Change from base Build 11888721535: -0.08%
Covered Lines: 6457
Relevant Lines: 7027

💛 - Coveralls

@rettigl
Copy link
Member

rettigl commented Nov 19, 2024

Can you clean up all not required files, remove output from notebooks, and make sure tests pass? Also, is it necessary to have different versions of config files, or can they just be updated also for the old example?

Copy link
Member

@rettigl rettigl left a comment

Choose a reason for hiding this comment

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

There are still some unused files (utils.py), and a lot of code in the Notebooks is rather redundant with other tutorials (energy calibration, saving, etc.), and not required for what you want to show. Also, it does not work in the current form outside maxwell (or even your account).

I restructured and streamlined the notebooks to some extend, see PR #524
After we agree on a version, this should still be rebased and all older commits with notebook output removed, integrated into the docs, made sure they compile during docs building, etc.

@kutnyakhov
Copy link
Collaborator Author

@rettigl thanks for cleaning up everything - your fixes branch now looks quite straightforward. Also, I like this comparison of both calibration methods, which at the end shows that the 4.5 eV range with SB calibration is even better than the 3 eV range with bias - it gives a proper 2.2 eV difference between W4f peaks.
utils.py file is not needed here - I just missed it during the last clean-up - but, in general, it should still be implemented at some point for spot size determination - I am preparing one more tutorial using different fluences, 2D Gauss fit and methods from Mac's paper for photoemission order.

In case we want to have also metadata - I can download a recent version from SciCat as json file that we can add to work outside of Maxwell.

@rettigl
Copy link
Member

rettigl commented Nov 21, 2024

but, in general, it should still be implemented at some point for spot size determination - I am preparing one more tutorial using different fluences, 2D Gauss fit and methods from Mac's paper for photoemission order.

I suggest to implement such methods into the framework of the calibrator classes. I remember @steinnymir started working on such methods at some point. See #270
The branches still exist and can be used as a starting point.

In case we want to have also metadata - I can download a recent version from SciCat as json file that we can add to work outside of Maxwell.

We can add this later eventually if we want to, I don't think it that important for these tutorials, which aim at a specific functionality.

I will merge the fixes branch then here, rebase, and integrate these tutorials into the docs structure when I find time.

@kutnyakhov
Copy link
Collaborator Author

but, in general, it should still be implemented at some point for spot size determination - I am preparing one more tutorial using different fluences, 2D Gauss fit and methods from Mac's paper for photoemission order.

I suggest to implement such methods into the framework of the calibrator classes. I remember @steinnymir started working on such methods at some point. See #270 The branches still exist and can be used as a starting point.

This utils.py comes from Steinn and I am/was just trying to finalize it :)

In case we want to have also metadata - I can download a recent version from SciCat as json file that we can add to work outside of Maxwell.

We can add this later eventually if we want to, I don't think it that important for these tutorials, which aim at a specific functionality.

Yes, I agree that this is not so important here.

I will merge the fixes branch then here, rebase, and integrate these tutorials into the docs structure when I find time.

Just a small correction before you merge to No.11 notebook for SB calibration cell:

  • I would use sp_44498.ec.tof = res_corr['dldTimeSteps'].data instead of data.dldTimeSteps.data - longer range - looks better :)
  • we don't need `params = sp_44498.calibrate_energy_axis(' - you removed it and it is not needed any more

@rettigl rettigl force-pushed the new-tutorials-for-hextof branch from df48bd0 to b56605e Compare November 21, 2024 13:21
rettigl and others added 4 commits November 21, 2024 16:02
…D using new dataset from Zenodo

Added one more notebook for HEXTOF - energy calibration using SB

Removed some copy/not needed files

Cleaned up all not required files

clear notebook output

clean up tutorials

add reference energy calibration, and allow using processor function with preview

remove unnecessary stuff

add energy comparison

remove kernel specs

further clean up

spell fixes

remove outdated config file
@rettigl rettigl force-pushed the new-tutorials-for-hextof branch from b56605e to 4d4000b Compare November 21, 2024 15:03
@rettigl rettigl merged commit bd69746 into main Nov 21, 2024
6 checks passed
@rettigl rettigl deleted the new-tutorials-for-hextof branch November 21, 2024 15:10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Energy calibration for core levels using side bands
3 participants