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

Getting started doc rewrite #2903

Merged
merged 2 commits into from
Jul 31, 2024
Merged

Getting started doc rewrite #2903

merged 2 commits into from
Jul 31, 2024

Conversation

ArnoStrouwen
Copy link
Member

The getting started documentation is currently a confusing combination of sometimes using the mtkmodel macro, and sometimes not. This PR puts as much functionality as possible into said macro, and removes all sidetracking explanations of the more manual definitions of ODESystems and ODEProblem.

I'll also take the opportunity to note the sentences in the tutorial I did not fully understand:

And the independent variable t is automatically added by @mtkmodel.

Added where exactly?

Vector-valued parameters and variables are possible. A cleaner, more
consistent treatment of these is still a work in progress, however. Once finished,
this introductory tutorial will also cover this feature.

Is this ready by now?

Observed equations are variables which can be computed on-demand but are not necessary for the solution of the system.

Calculating RHS is definitely needed for solving the system (you can see this by inspecting prob.f.f.f_oop, it is just not a state of the dynamic system? I don't know how to succinctly rewrite this.

@ChrisRackauckas ChrisRackauckas merged commit 0726a4d into SciML:master Jul 31, 2024
2 checks passed
@ArnoStrouwen ArnoStrouwen deleted the docs branch July 31, 2024 15:03
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

Successfully merging this pull request may close these issues.

2 participants