Documentation page on how to access model properties #889
+250
−0
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
TorkelE
commented
May 31, 2024
| !!! warn | ||
| Generally, the field of Julia structures can be accessed through `struct.field`. E.g. a simulation's time vector can be retrieved using `simulation.t`. While Catalyst `ReactionSystem`s are structures, one should *never* access their fields using this approach, but rather using the accessor functions described below and in the [API](@ref ref) (direct accessing of fields can yield unexpected behaviours). E.g. to retrieve the species of a `ReactionsSystem` `rs`, use `Catalyst.get_species(rs)`, *not* `rs.species`. | ||
|
|
||
| ## [Direct accessing of symbolic model parameter and species](@id model_accessing_symbolic_variables) |
There was a problem hiding this comment.
I think it is good to have a dedicated section going through this, and I think this is a place where it makes sense to put it (the other alternatives would be the advanced introduction or the compositional modelling part, right now I feel this was the most fitting place).
TorkelE
commented
May 31, 2024
| ModelingToolkit.get_iv(sir) | ||
| ``` | ||
|
|
||
| ## [Accessing properties of hierarchical models](@id model_accessing_hierarchical) |
There was a problem hiding this comment.
There is quite a lot on this, but I felt it was good to go through it properly (as I personally also have been a bit unfamiliar with it). Definitely check this part in case I have made a misstake.
TorkelE
changed the title
TorkelE
changed the title
TorkelE
changed the title
TorkelE
changed the title
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Not actually sure what to call this one, but this is the tutorial that goes through how to access stuff within a
ReactionSystem.species(rs).rs.X) works.get_speciesandspecies, andrs.submodelname.X.