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 docstrings #107

Open
ranocha opened this issue Jan 22, 2021 · 2 comments
Open

Improve docstrings #107

ranocha opened this issue Jan 22, 2021 · 2 comments

Comments

@ranocha
Copy link

ranocha commented Jan 22, 2021

Some docstrings are not really helpful, e.g.

julia> using GeometricIntegrators
help?> Integrator
search: Integrator Integrators IntegratorRK IntegratorERK IntegratorIPRK IntegratorFLRK IntegratorFIRK

  Print error for integrators not implemented, yet.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for explicit Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for diagonally implicit Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for fully implicit Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for explicit partitioned Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for implicit partitioned Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for variational partitioned Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for formal Lagrangian Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for Projected Gauss-Legendre Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for variational partitioned additive Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for special partitioned additive Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for variational special partitioned additive Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for variational special partitioned additive Runge-Kutta tableau with projection on primary
  constraint.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for variational special partitioned additive Runge-Kutta tableau with projection on
  secondary constraint.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for Hamiltonian partitioned additive Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for Hamiltonian special partitioned additive Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for Hamiltonian special partitioned additive Runge-Kutta tableau with projection on primary
  constraint.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for splitting tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for stochastic explicit Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for weak explicit Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for stochastic fully implicit Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for stochastic fully implicit partitioned Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for stochastic fully implicit split partitioned Runge-Kutta tableau.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Create integrator for weak fully implicit Runge-Kutta tableau.

help?> integrate
search: integrate integrate! integrate_step! IntegratorERK IntegratorEPRK IntegratorExactODE

  Apply integrator for ntime time steps and return solution.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Integrate given equation with given tableau for ntime time steps and return solution.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Integrate ODE specified by vector field and initial condition with given tableau for ntime time steps and
  return solution.

  ─────────────────────────────────────────────────────────────────────────────────────────────────────────────

  Integrate PODE specified by two vector fields and initial conditions with given tableau for ntime time steps
  and return solution.

help?> TableauExplicitEuler
search: TableauExplicitEuler TableauExplicitMidpoint

  Tableau for explicit Euler method

I still don't know how to call the corresponding methods.

@michakraus
Copy link
Member

michakraus commented Feb 11, 2021

I updated the docstrings for

Equations
Solutions
AtomicSolutions
Integrator
integrate
integrate!

to make them somewhat more useful. There's still quite some room for improvement though...

@michakraus
Copy link
Member

I also added constructor descriptions to the docstrings of the tableaus in RungeKutta.jl.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants