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

Improve documententation for how to attach numerical solvers #78

Open
sjdaines opened this issue Apr 28, 2023 · 0 comments
Open

Improve documententation for how to attach numerical solvers #78

sjdaines opened this issue Apr 28, 2023 · 0 comments
Labels
documentation Improvements or additions to documentation

Comments

@sjdaines
Copy link
Member

Need a clear description somewhere (eg at the start of https://paleotoolkit.github.io/PALEOboxes.jl/stable/Solver%20API/) of the overall approach:

  • aggregate state variables etc during model setup
  • each timestep, set PALEO state from solver using variable aggregator, dispatch reactions, read eg time derivative using variable aggregator

https://paleotoolkit.github.io/PALEOboxes.jl/stable/CreateInitializeLoop/ doesn't mention attaching a solver

https://paleotoolkit.github.io/PALEOboxes.jl/stable/Solver%20API/ doesn't cross-reference PALEOmodel.jl and could be better organized

@sjdaines sjdaines added the documentation Improvements or additions to documentation label Apr 28, 2023
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

No branches or pull requests

1 participant