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

Describe the underlying maths and numerical implementations in vignette #176

Open
TimTaylor opened this issue Jul 20, 2023 · 6 comments
Open
Labels
Documentation Improvements or additions to documentation Help wanted Extra attention is needed

Comments

@TimTaylor
Copy link

TimTaylor commented Jul 20, 2023

Currently the documentation is missing any real description of the methods employed, both in terms of the underlying mathematics and the numerical solver implementations. Whilst references to papers are given, as a user I would appreciate the package being self contained with all relevant information, including methodology assumptions, available in a vignette.

@TimTaylor TimTaylor added the Documentation Improvements or additions to documentation label Jul 20, 2023
@pratikunterwegs
Copy link
Collaborator

Thanks @TimTaylor - I've been thinking about this for a while as something that's needed, but I don't have the maths chops to describe this usefully (or to know whether I'm correct!) - @BlackEdder or @rozeggo, would you be able to take a stab at this? I remember a hack.md document was written some time ago.

@TimTaylor
Copy link
Author

TimTaylor commented Jul 20, 2023

I'll probably raise a general discussion on this point. It really applies to all maths/methods type packages that will be created.

@pratikunterwegs pratikunterwegs added the Help wanted Extra attention is needed label Jul 20, 2023
@pratikunterwegs
Copy link
Collaborator

Thanks, that would be pretty helpful - see also issue #126 as related. How detailed would you say this needs to be? See for example the vignettes for {cfr} which have some maths - I guess one or two key equations are not enough?

@TimTaylor
Copy link
Author

I'd like text book / course level details. Will raise the discussion over next few days, possibly next week.

@TimTaylor
Copy link
Author

I was unable to move this issue but I've raised in disucssions. For some reason this hasn't auto-linked hence the comment.

@pratikunterwegs
Copy link
Collaborator

Thanks - just saw it. I'm not sure how to move it either yet, haven't used Discussions much, will look into it.

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 Help wanted Extra attention is needed
Projects
None yet
Development

No branches or pull requests

2 participants