Skip to content

Refactored ODESystem composition and accessor function docs (#3505); … #3545

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.

Sign up for GitHub

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

Closed
wants to merge 3 commits into from
Closed

Refactored ODESystem composition and accessor function docs (#3505); … #3545

Changes from 2 commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b61198d
Refactored ODESystem composition and accessor function docs (#3505); …
ayush2281 Apr 8, 2025
f001c5e
Update ODESystem.md
ayush2281 Apr 8, 2025
7039d39
Update ODESystem.md
ayush2281 Apr 8, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
36 changes: 21 additions & 15 deletions docs/src/systems/ODESystem.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,21 +8,27 @@ ODESystem

## Composition and Accessor Functions

- `get_eqs(sys)` or `equations(sys)`: The equations that define the ODE.
- `get_unknowns(sys)` or `unknowns(sys)`: The set of unknowns in the ODE.
- `get_ps(sys)` or `parameters(sys)`: The parameters of the ODE.
- `get_iv(sys)`: The independent variable of the ODE.
- `get_u0_p(sys, u0map, parammap)` Numeric arrays for the initial condition and parameters given `var => value` maps.
- `continuous_events(sys)`: The set of continuous events in the ODE.
- `discrete_events(sys)`: The set of discrete events in the ODE.
- `alg_equations(sys)`: The algebraic equations (i.e. that does not contain a differential) that defines the ODE.
- `get_alg_eqs(sys)`: The algebraic equations (i.e. that does not contain a differential) that defines the ODE. Only returns equations of the current-level system.
- `diff_equations(sys)`: The differential equations (i.e. that contain a differential) that defines the ODE.
- `get_diff_eqs(sys)`: The differential equations (i.e. that contain a differential) that defines the ODE. Only returns equations of the current-level system.
- `has_alg_equations(sys)`: Returns `true` if the ODE contains any algebraic equations (i.e. that does not contain a differential).
- `has_alg_eqs(sys)`: Returns `true` if the ODE contains any algebraic equations (i.e. that does not contain a differential). Only considers the current-level system.
- `has_diff_equations(sys)`: Returns `true` if the ODE contains any differential equations (i.e. that does contain a differential).
- `has_diff_eqs(sys)`: Returns `true` if the ODE contains any differential equations (i.e. that does contain a differential). Only considers the current-level system.
```@docs
Copy link
Contributor

@Datseris Datseris Apr 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You have to use canonical = false here. I doubt the canonical place for these docstrings is under the O-DE system.

Copy link
Member

@AayushSabharwal AayushSabharwal Apr 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think @Datseris meant ```@docs canonical=false. Also, not all of these functions have docstrings so I believe overall it's better as it was before.

Copy link
Member

@AayushSabharwal AayushSabharwal Apr 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The ``` block isn't closed either.

Copy link
Contributor

@Datseris Datseris Apr 8, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I've reported this as spam.

canonical = false here
get_eqs
equations
get_unknowns
unknowns
get_ps
parameters
get_iv
get_u0_p
continuous_events
discrete_events
alg_equations
get_alg_eqs
diff_equations
get_diff_eqs
has_alg_equations
has_alg_eqs
has_diff_equations
has_diff_eqs


## Transformations

Expand Down
Loading