Skip to content

Doc updates: README, Home, FAW, and API#1391

Merged
TorkelE merged 8 commits intomasterfrom
doc_updates_1
Feb 13, 2026
Merged

Doc updates: README, Home, FAW, and API#1391
TorkelE merged 8 commits intomasterfrom
doc_updates_1

Conversation

@TorkelE
Copy link
Copy Markdown
Member

@TorkelE TorkelE commented Feb 7, 2026

No description provided.

Comment thread docs/src/api/core_api.md
# solve as ODEs
odesys = ode_model(rs)
odesys = complete(odesys)
oprob = ODEProblem(odesys, u₀map, tspan, parammap)
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

Going through odesys here didn't feel necessary in the context of the FAW, so dropped it so that we don't have to change syntax

Comment thread docs/src/api/core_api.md
- [`continuous_events`](@ref events): Allows the creation of continuous events.
- [`discrete_events`](@ref events): Allows the creation of discrete events.
- `brownians`: Allows the creation of brownian processes that can be used to add noise to non-species variables.
- `poissonians`: Allows the creation of poissonian processes that can be used to add jump events to non-species variables.
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

need to remember to add links here once appropriate docs are up. Might be able to at least write a small section on each taht we can expand later on.

Comment thread docs/src/api/core_api.md
can call:

* `ModelingToolkitBase.unknowns(rn)` returns all species *and variables* across the
system, *all sub-systems*, and all constraint systems. Species are ordered
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

We no longer have these, right?

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

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

Yes, no constraint systems since ReactionSystem can be anything now.

Comment thread docs/src/faqs.md
It is possible to turn off all inference (requiring all symbols to be declared using `@parameters`, `@species`, `@variables`, or some other option) through the [`@require_declaration` option](@ref faq_require_declaration).

## [How can I turn off automatic inferring of species and parameters when using the DSL?](@id faq_require_declaration)
This option can be set using the `@require_declaration` option inside `@reaction_network`. In this case all the species, parameters, and variables in the system must be pre-declared using one of the `@species`, `@parameters`, or `@variables` macros. For more information about what is inferred automatically and not, please see the section on [`@require_declaration`](@ref dsl_advanced_options_require_dec).
Copy link
Copy Markdown
Member Author

Choose a reason for hiding this comment

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

The FAW file has on section on conservation laws, but it is to late in the eveningfor me wanting to have a look at that.

@TorkelE TorkelE merged commit ddb0d04 into master Feb 13, 2026
19 checks passed
@TorkelE TorkelE deleted the doc_updates_1 branch February 13, 2026 12:00
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