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 some tutorials #255

Merged
merged 20 commits into from
Jan 26, 2024
Merged

Add some tutorials #255

merged 20 commits into from
Jan 26, 2024

Conversation

Radonirinaunimi
Copy link
Member

For the sake of the paper https://github.com/N3PDF/papers/pull/26, this adds a short tutorial that should only contain the essentials.

As it is right now, this is not ready yet and I will be working on the contents. But are we satisfied with the structure? If so, then I can carry on.

cc @alecandido, @felixhekhorn, @giacomomagni, @RoyStegeman: if there are other aspects to be covered, please suggest and/or feel free to edit directly.

@felixhekhorn felixhekhorn added documentation Improvements or additions to documentation and removed tutorials labels Jan 19, 2024
@felixhekhorn
Copy link
Contributor

Should we weave (copy) the Como tutorial in here?

@Radonirinaunimi
Copy link
Member Author

Should we weave (copy) the Como tutorial in here?

That might be a good idea. Maybe not the whole tutorial though (?) since most of parts of the tutorial are pre-yadism. Maybe we can just port the part in which we compare with data? So there would be two main sections:

  • the current tutorial -> Getting started
  • comparison to measurements

Or do you want to really start from the basics->yadism?

@felixhekhorn
Copy link
Contributor

Maybe we can just port the part in which we compare with data?

yes, that should be sufficient

@Radonirinaunimi
Copy link
Member Author

Maybe we can just port the part in which we compare with data?

yes, that should be sufficient

Ok, I will add that part here.

@giacomomagni
Copy link
Collaborator

giacomomagni commented Jan 19, 2024

To remember some TODOs left in the documentation:

  • TMC, both for theory section and implementation.
  • Complete kernels and ESFResult in the implementation section.
  • Add something about FFN0 in the theory section and clarify that FONLL is not implemented only by Yadism.

@felixhekhorn felixhekhorn mentioned this pull request Jan 26, 2024
2 tasks
@felixhekhorn felixhekhorn merged commit cf50107 into master Jan 26, 2024
4 of 5 checks passed
@felixhekhorn felixhekhorn deleted the tutorial branch January 26, 2024 12:09
@giacomomagni giacomomagni mentioned this pull request Feb 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants