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

Coupled eqs doc expansion #815

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

Coupled eqs doc expansion #815

wants to merge 8 commits into from

Conversation

TorkelE
Copy link
Member

@TorkelE TorkelE commented May 9, 2024

Create new doc for coupled equations

Base automatically changed from Catalyst_version_14 to master May 15, 2024 17:37
@@ -9,7 +9,7 @@ pages = Any[
"model_creation/dsl_description.md",
# DSL - Advanced
"model_creation/programmatic_CRN_construction.md",
"model_creation/constraint_equations.md",
"model_creation/coupled_crn_equations.md",
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 old file is still around. Do you think it would make sense to turn it into an example of how to combine equations + events + CRN models? It is a bit more straightforward with the examples, while this new one simply goes through all options one by one.

```
We note that while modelling of higher-order coupled CRN/differential equation models using the DSL is a bit convoluted (due to the requirement of re-declaring the differential outside of the DSL), this is not the case for [programmatic modelling](@ref coupled_equations_programmatic). Hence, for these models, this is instead the recommended approach.

## [Coupled CRN/equation models for programmatic modelling](@id coupled_equations_programmatic)
Copy link
Member Author

Choose a reason for hiding this comment

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

Right now, I start with going through how coupling work with the DSL. Then, at the end I have a separate section describing the details one needs to change when using a programmatic workflow (here and most other cases it is straightforward, except for the base syntax the two approaches are really similar).

Copy link
Member Author

Choose a reason for hiding this comment

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

How to compose ODESystems with ReactionSystems will be in the compositional modelling part (or at least I think that was our plan when we discussed this a while ago, still happy to change things around)

@TorkelE TorkelE changed the title Coupled eqs docs [Documentation - Ready] Coupled eqs doc expansion Jun 5, 2024
@TorkelE TorkelE changed the title [Documentation - Ready] Coupled eqs doc expansion [Non-urgent - Ready] Coupled eqs doc expansion Jun 11, 2024
@TorkelE TorkelE changed the title [Non-urgent - Ready] Coupled eqs doc expansion Coupled eqs doc expansion Jul 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant