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

The documentation does not explain how to use ClimaTimeSteppers #267

Open
Sbozzolo opened this issue Apr 1, 2024 · 2 comments
Open

The documentation does not explain how to use ClimaTimeSteppers #267

Sbozzolo opened this issue Apr 1, 2024 · 2 comments
Labels
documentation Improvements or additions to documentation

Comments

@Sbozzolo
Copy link
Member

Sbozzolo commented Apr 1, 2024

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 Sbozzolo added the documentation Improvements or additions to documentation label Apr 1, 2024
@Sbozzolo Sbozzolo added this to the Maintenance and Improvements milestone Apr 22, 2024
@Sbozzolo
Copy link
Member Author

Sbozzolo commented May 4, 2024

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

  • When using ClimaCore, Y has to be a FieldVector (cannot be a Field)
  • What is Wfact
  • What is Wfact_t and the relationship with Wfact
  • And there is lots and lots of things that I still haven't figured out (what is jac_prototype?)

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
Copy link
Member Author

Sbozzolo commented Nov 7, 2024

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).

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