CliMA / ClimaTimeSteppers.jl

A CPU- and GPU-friendly package for solving ordinary differential equations
Apache License 2.0
50 stars 5 forks source link

The documentation does not explain how to use `ClimaTimeSteppers` #267

Open Sbozzolo opened 7 months ago

Sbozzolo commented 7 months ago

As the title suggests, there is no documentation in https://clima.github.io/ClimaTimeSteppers.jl/dev/ on how to use ClimaTimeSteppers.jl.

It is also hard to find a simple example among the tests.

Sbozzolo commented 6 months ago

Here are some of the things I would have never figured out by myself (not for lack of trying):

ClimaTimeSteppers is a foundational package. I think that the fact that the only place where information about this package is the brains of a restricted number of individuals should be fixed as soon as possible.

Sbozzolo commented 23 hours ago

Even after having used this package for a while, I am still struggling. The package does not even come with one example on how to set up a simple scalar problem (in particular, with an implicit component).