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

[Non-urgent - Ready] Advanced introduction to Catalyst and its internal #890

Open
wants to merge 7 commits into
base: master
Choose a base branch
from

Conversation

TorkelE
Copy link
Member

@TorkelE TorkelE commented May 30, 2024

Again not sure what to call this one.

This is basically a third introduction page. While the two previous ones are more or less parallel (i.e. have the same purpose, but for people who know/do not know Julia), this one is a continuation. It doesn't really go through any core stuff per see, but have two functions:

  • Describe some of the internals, i.e. how Catalyst creates various types of MTK systems, and how stuff are internally represented.
  • Provide short introductions to modelling workflows in the same place. I.e. there is a section that goes through DSL-based, programmatic, and compositional modelling. Since these are mostly kept separate, it is nice to have them next to each other same place, so that they can be easily compared.

(k1*k2)/k2, X --> 0
end
reactions(rn)[1].rate
```
Copy link
Member Author

Choose a reason for hiding this comment

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

Here I had more on symbolic simplifications performed, but looking at examples, it seems that these are never really done (even with structural_simplify).

!!! warn
When accessing species and parameters that are stored in a system using the above approach it is important to ensure that the model is *complete*. Model completeness is described [here](@ref ref).

## [Independent variables](@id advanced_intro_to_catalyst_independent_vars)
Copy link
Member Author

Choose a reason for hiding this comment

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

We should have a short section on independent variables somewhere (I hadn't really heard of this before MTK started using these), and somewhere here seemed natural. The main purpose of this one is that whenever we mention "independent variable" somewhere, we can link this section, and those who are unfamiliar with the term can read up on what it means.


Symbolic variables-based representation is strictly superior to symbol-based representation. However, it is generally only used in combination with programmatic modelling (as during DSL-based modelling we never actually declare the symbolic variables, and thus cannot use them directly). To use symbolic variables-based representation in combination with the DSL, the [`@unpack` macro can be used](@ref ref).

### [System-based symbolic designation](@id advanced_intro_to_catalyst_designations_sys_symb)
Copy link
Member Author

Choose a reason for hiding this comment

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

The new section on how to access content of models got a more extensive description of this.

@TorkelE TorkelE changed the title Advanced introduction to Catalyst and its internal [Ready] Advanced introduction to Catalyst and its internal Jun 5, 2024
@TorkelE TorkelE changed the title [Ready] Advanced introduction to Catalyst and its internal [Documentation - Ready] Advanced introduction to Catalyst and its internal Jun 5, 2024
@TorkelE TorkelE changed the title [Documentation - Ready] Advanced introduction to Catalyst and its internal [Non-urgent - Ready] Advanced introduction to Catalyst and its internal Jun 11, 2024
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.

None yet

1 participant