Get references for algorithms

[ranocha]

Currently, I do not know how to obtain a reference for a given algorithm that I should cite when using it in a research paper. For example, none of

julia> using GeometricIntegrators

julia> TableauQinZhang
TableauQinZhang (generic function with 1 method)

julia> TableauQinZhang()
TableauDIRK{Float64}(:qinzhang, 2, 2, Runge-Kutta Coefficients qinzhang with 2 stages and order 2  a = [0.25 0.0; 0.5 0.25]  b = [0.5, 0.5]  c = [0.25, 0.75])

help?> TableauQinZhang()
  Tableau of Qin and Zhang's symplectic two-stage, 2nd order method

help?> TableauQinZhang
search: TableauQinZhang

  Tableau of Qin and Zhang's symplectic two-stage, 2nd order method

works for this and I can't also find no reference in the source code.

[michakraus]

Thanks a lot! Very good point! I will start by adding all the references to the tableau docstrings in RungeKutta.jl. Then I need to see what would be the best way to make them accessible in GeometricIntegrators.jl without just copying everything. Anyhow, we want to automatise importing methods defined in RungeKutta.jl into GeometricIntegrators.jl, so that we don't have to amend the latter every time we add a new algorithm to the former. This seems to go hand in hand.

[ranocha]

Could you just use Reexport.jl for this?

[michakraus]

Not right now as there is a conversion from the tableau type in RungeKutta.jl into different tableau types in GeometricIntegrators.jl (explicit, diagonally implicit, fully implicit). That was originally used for dispatch on the different integrators. However, that could and should be implemented via traits, which would simplify the implementation and should allow for a simple reexport.

[michakraus]

The master branch of GeometricIntegrators.jl now uses RungeKutta.jl for the Tableaus. I added references to all tableaus in there. I still need to add references to the splitting methods...

[michakraus]

All Runge-Kutta and Splitting methods now have references:
https://juliagni.github.io/GeometricIntegrators.jl/latest/tableaus/rungekutta/
https://juliagni.github.io/GeometricIntegrators.jl/latest/tableaus/splitting/

Also the splitting integrators themselves have obtained some documentation:
https://juliagni.github.io/GeometricIntegrators.jl/latest/integrators/splitting/

A few more examples would be nice, but it's a start... I will also add the possibility to integrate partitioned equations (PODEs) with the splitting and composition methods.

[ranocha]

Thanks, this is really helpful!

Although it's not related directly to this issue: On the first page you linked above, there are two show methods described. However, I have no clue how to call them since the signature is omitted, see below.

[michakraus]

Thanks. There are quite a few of those in the library. Docstrings are a general problem, where the library doesn't shine (yet)... working on it!