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

General improvments to the documentation - in particular describing the model motivating the procedure #7

Open
jokasimr opened this issue Oct 24, 2023 · 2 comments

Comments

@jokasimr
Copy link
Contributor

  • The definitions of some parameters in the workflow are missing. See essreflectometry/amor/typing.py.
  • Model motivating the footprint correction coefficient is missing.
  • Model motivating the supermirror calibration is missing.
@nvaytet
Copy link
Member

nvaytet commented Feb 23, 2024

Is this about adding the information (mathematical expressions) from the old notebook in the ess repo?

If so, a couple are missing from the list:

  • For the resolution function, there are references to an article, but we could also add the math for our docs
  • There is also a link to a reference for the conversion to theta, but the mathematical expression could be included

Some of the figures (about angle conventions) in the old notebook are also very useful. We should make sure we don't lose them.

Finally, in the normalization section, there was some discussion about why we compute the mean and not the sum to make the final 1D plot. I remember we talked about this with Drew for a while, and this info should also be preserved.

@jokasimr jokasimr changed the title Document the model the workflow is based on General improvments to the documentation - in particular describing the model motivating the procedure Jun 11, 2024
@jokasimr
Copy link
Contributor Author

There is some discussion in #44 that might be useful for this issue.

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

No branches or pull requests

2 participants