Improve documententation for how to attach numerical solvers - Githubissues

PALEOtoolkit / PALEOboxes.jl

Model coupler for the PALEO model framework

https://PALEOtoolkit.github.io/PALEOboxes.jl

MIT License

2 stars 1 forks source link

Improve documententation for how to attach numerical solvers #78

Open sjdaines opened 1 year ago

sjdaines commented 1 year ago

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