You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/src/index.md
+14-14Lines changed: 14 additions & 14 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,4 +1,4 @@
1
-
# [Catalyst.jl for Reaction Network Modeling](@iddoc_home)
1
+
# [Catalyst.jl for Reaction Network Modeling](@iddoc_index)
2
2
3
3
Catalyst.jl is a symbolic modeling package for analysis and high-performance
4
4
simulation of chemical reaction networks. Catalyst defines symbolic
@@ -16,9 +16,9 @@ Generated models can be used with solvers throughout the broader
16
16
for sensitivity analysis, parameter estimation, machine learning applications,
17
17
etc).
18
18
19
-
## [Features](@iddoc_home_features)
19
+
## [Features](@iddoc_index_features)
20
20
21
-
#### [Features of Catalyst](@iddoc_home_features_catalyst)
21
+
#### [Features of Catalyst](@iddoc_index_features_catalyst)
22
22
-[The Catalyst DSL](@ref dsl_description) provides a simple and readable format for manually specifying reaction
23
23
network models using chemical reaction notation.
24
24
- Catalyst `ReactionSystem`s provides a symbolic representation of reaction networks,
@@ -52,7 +52,7 @@ etc).
52
52
deterministic and stochastic terms within resulting ODE, SDE or jump models.
53
53
-[Steady states](@ref homotopy_continuation) (and their [stabilities](@ref steady_state_stability)) can be computed for model ODE representations.
54
54
55
-
#### [Features of Catalyst composing with other packages](@iddoc_home_features_composed)
55
+
#### [Features of Catalyst composing with other packages](@iddoc_index_features_composed)
56
56
-[OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl) Can be used to numerically solver generated reaction rate equation ODE models.
57
57
-[StochasticDiffEq.jl](https://github.com/SciML/StochasticDiffEq.jl) can be used to numerically solve generated Chemical Langevin Equation SDE models.
58
58
-[JumpProcesses.jl](https://github.com/SciML/JumpProcesses.jl) can be used to numerically sample generated Stochastic Chemical Kinetics Jump Process models.
@@ -79,7 +79,7 @@ etc).
79
79
[global sensitivity analysis](@ref global_sensitivity_analysis) of model behaviors.
80
80
-[SciMLSensitivity.jl](https://github.com/SciML/SciMLSensitivity.jl) can be used to compute local sensitivities of functions containing forward model simulations.
81
81
82
-
#### [Features of packages built upon Catalyst](@iddoc_home_features_other_packages)
82
+
#### [Features of packages built upon Catalyst](@iddoc_index_features_other_packages)
83
83
- Catalyst [`ReactionSystem`](@ref)s can be [imported from SBML files](@id model_file_import_export_sbml) via
84
84
[SBMLImporter.jl](https://github.com/SciML/SBMLImporter.jl) and [SBMLToolkit.jl](https://github.com/SciML/SBMLToolkit.jl),
85
85
and [from BioNetGen .net files](@ref model_file_import_export_sbml_rni_net) and various stoichiometric matrix network representations
@@ -96,7 +96,7 @@ etc).
96
96
-[BondGraphs.jl](https://github.com/jedforrest/BondGraphs.jl), a package for
97
97
constructing and analyzing bond graphs models, which can take Catalyst models as input.
98
98
99
-
## [How to read this documentation](@iddoc_home_documentation)
99
+
## [How to read this documentation](@iddoc_index_documentation)
100
100
The Catalyst documentation is separated into sections describing Catalyst's various features. Where appropriate, some sections will also give advice on best practices for various modeling workflows, and provide links with further reading. Each section also contains a set of relevant example workflows. Finally, the [API](@ref api) section contains a list of all functions exported by Catalyst (as well as descriptions of them and their inputs and outputs).
101
101
102
102
New users are recommended to start with either the [Introduction to Catalyst and Julia for New Julia users](@ref catalyst_for_new_julia_users) or [Introduction to Catalyst](@ref introduction_to_catalyst) sections (depending on whether they are familiar with Julia programming or not). This should be enough to carry out many basic Catalyst workflows.
@@ -126,7 +126,7 @@ end
126
126
nothing # hide
127
127
```
128
128
129
-
## [Installation](@iddoc_home_installation)
129
+
## [Installation](@iddoc_index_installation)
130
130
Catalyst is an officially registered Julia package, which can be installed through the Julia package manager:
131
131
```julia
132
132
using Pkg
@@ -142,9 +142,9 @@ is also needed.
142
142
143
143
A more throughout guide for setting up Catalyst and installing Julia packages can be found [here](@ref catalyst_for_new_julia_users_packages).
144
144
145
-
## [Illustrative example](@iddoc_home_example)
145
+
## [Illustrative example](@iddoc_index_example)
146
146
147
-
#### [Deterministic ODE simulation of Michaelis-Menten enzyme kinetics](@iddoc_home_example_ode)
147
+
#### [Deterministic ODE simulation of Michaelis-Menten enzyme kinetics](@iddoc_index_example_ode)
148
148
Here we show a simple example where a model is created using the Catalyst DSL, and then simulated as
If you use this functionality in your research, [in addition to Catalyst](@refcatalyst_citation), please cite the following paper to support the authors of the GlobalSensitivity.jl package:
145
+
If you use this functionality in your research, [in addition to Catalyst](@refdoc_index_citation), please cite the following paper to support the authors of the GlobalSensitivity.jl package:
146
146
```
147
147
@article{dixit2022globalsensitivity,
148
148
title={GlobalSensitivity. jl: Performant and Parallel Global Sensitivity Analysis with Julia},
Copy file name to clipboardExpand all lines: docs/src/model_creation/model_file_loading_and_export.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -136,7 +136,7 @@ The advantage of these forms is that they offer a compact and very general way t
136
136
137
137
---
138
138
## [Citations](@id petab_citations)
139
-
If you use any of this functionality in your research, [in addition to Catalyst](@refcatalyst_citation), please cite the paper(s) corresponding to whichever package(s) you used:
139
+
If you use any of this functionality in your research, [in addition to Catalyst](@refdoc_index_citation), please cite the paper(s) corresponding to whichever package(s) you used:
Copy file name to clipboardExpand all lines: docs/src/steady_state_functionality/dynamical_systems.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -124,7 +124,7 @@ More details on how to compute Lyapunov exponents using DynamicalSystems.jl can
124
124
125
125
---
126
126
## [Citations](@id dynamical_systems_citations)
127
-
If you use this functionality in your research, [in addition to Catalyst](@refcatalyst_citation), please cite the following paper to support the author of the DynamicalSystems.jl package:
127
+
If you use this functionality in your research, [in addition to Catalyst](@refdoc_index_citation), please cite the following paper to support the author of the DynamicalSystems.jl package:
Copy file name to clipboardExpand all lines: docs/src/steady_state_functionality/nonlinear_solve.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -133,7 +133,7 @@ However, especially when the forward ODE simulation approach is used, it is reco
133
133
134
134
---
135
135
## [Citations](@id nonlinear_solve_citation)
136
-
If you use this functionality in your research, [in addition to Catalyst](@refcatalyst_citation), please cite the following paper to support the authors of the NonlinearSolve.jl package:
136
+
If you use this functionality in your research, [in addition to Catalyst](@refdoc_index_citation), please cite the following paper to support the authors of the NonlinearSolve.jl package:
137
137
```
138
138
@article{pal2024nonlinearsolve,
139
139
title={NonlinearSolve. jl: High-Performance and Robust Solvers for Systems of Nonlinear Equations in Julia},
Copy file name to clipboardExpand all lines: docs/unpublished/petab_ode_param_fitting.md
+1-1Lines changed: 1 addition & 1 deletion
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -523,7 +523,7 @@ There exist several types of plots for both types of calibration results. More d
523
523
524
524
---
525
525
## [Citations](@id petab_citations)
526
-
If you use this functionality in your research, [in addition to Catalyst](@refcatalyst_citation), please cite the following papers to support the authors of the PEtab.jl package (currently there is no article associated with this package) and the PEtab standard:
526
+
If you use this functionality in your research, [in addition to Catalyst](@refdoc_index_citation), please cite the following papers to support the authors of the PEtab.jl package (currently there is no article associated with this package) and the PEtab standard:
527
527
```
528
528
@misc{2023Petabljl,
529
529
author = {Ognissanti, Damiano AND Arutjunjan, Rafael AND Persson, Sebastian AND Hasselgren, Viktor},
0 commit comments