Api doc proposed changes #862
Merged
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
force-pushed
the
api_doc_proposed_changes
branch
2 times, most recently
from
725af63
to
ffbe3cc
Compare
TorkelE
force-pushed
the
api_doc_proposed_changes
branch
from
ffbe3cc
to
007e809
Compare
TorkelE
commented
May 29, 2024
| @@ -35,37 +35,41 @@ corresponding chemical reaction ODE models, chemical Langevin equation SDE | |||
| models, and stochastic chemical kinetics jump process models. | |||
|
|
|||
| ```@example ex1 | |||
| using Catalyst, DifferentialEquations, Plots | |||
There was a problem hiding this comment.
I have tried to remove all cases of DifferentialEquations
TorkelE
commented
May 29, 2024
| t = default_t() | ||
| @parameters β γ | ||
| @species S(t) I(t) R(t) | ||
|
|
||
| rxs = [Reaction(β, [S,I], [I], [1,1], [2]) | ||
| Reaction(γ, [I], [R])] | ||
| @named rs = ReactionSystem(rxs, t) | ||
| rs = complete(rs) |
There was a problem hiding this comment.
completeness is now required for all systems.
TorkelE
commented
May 29, 2024
| jprob = JumpProblem(jumpsys, dprob, Direct()) | ||
| sol = solve(jprob, SSAStepper()) | ||
| jprob = JumpProblem(jumpsys, dprob, Direct(); save_positions = (false,false)) | ||
| sol = solve(jprob, SSAStepper(), saveat = 2.0) |
There was a problem hiding this comment.
When going through the doc build times, the rendering of large figures was the biggest problem. When building the docs (containing only the API) locally, reducing the saveat for these stochastic simulations reduced the build time from over 250 seconds to 15 seconds.
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.
The minimum required changes to make the API build on the new version.