WIP: beginning to refactor network analysis docs #1142
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
|
Having network analysis be its own section is fine. LMK when you feel this is ready to review. |
…r-docs pull master
…r-docs bring in adjacencymat changes
TorkelE
reviewed
Feb 6, 2025
| @@ -0,0 +1,4 @@ | |||
| # [Advanced Analysis using CatalystNetworkAnalysis](@id catalyst_network_analysis) | |||
There was a problem hiding this comment.
Just checking, is this a wip? If not, having a direct link to that package would definitely be a good start.
TorkelE
reviewed
Feb 6, 2025
| @@ -0,0 +1,352 @@ | |||
| # [Decomposing the Reaction Network ODEs](@id network_analysis_odes) | |||
There was a problem hiding this comment.
Maybe we should add a link to the intro page that Sam wrote describing how these ODEs are generated?
TorkelE
reviewed
Feb 6, 2025
| @@ -1,219 +1,26 @@ | |||
| # [Network Analysis in Catalyst](@id network_analysis) | |||
| # [Chemical Reaction Network Theory](@id network_analysis_structural_aspects) | |||
There was a problem hiding this comment.
I'd probably call the file "crn_theory.md", more descriptive at a first glance for people unfamiliar with it.
(but feel free to keep current name as well!)
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.
Probably worth discussing more but my thought here is to make Network Analysis its own section of the Catalyst docs, with subsections for the ODE decompositions, structural properties and chemical reaction network theory, and a third section for advanced stuff that links to CatalystNetworkAnalysis.
Added sections for the new API functions in #1134 and building symbolic functions from the ODEs to the ODE docs. Added a section on complex/detailed balance to the CRNT docs.
Need to: add a section on the deficiency one theorem, bring in the CatalystNetworkAnalysis docs, add code examples to the complex/detailed balance section (including stuff about the precision limitations of
isdetailedbalanced)