Skip to content

Commit c0df380

Browse files
committed
update citation cross references
1 parent dd12686 commit c0df380

File tree

6 files changed

+19
-19
lines changed

6 files changed

+19
-19
lines changed

docs/src/index.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
1-
# [Catalyst.jl for Reaction Network Modeling](@id doc_home)
1+
# [Catalyst.jl for Reaction Network Modeling](@id doc_index)
22

33
Catalyst.jl is a symbolic modeling package for analysis and high-performance
44
simulation of chemical reaction networks. Catalyst defines symbolic
@@ -16,9 +16,9 @@ Generated models can be used with solvers throughout the broader
1616
for sensitivity analysis, parameter estimation, machine learning applications,
1717
etc).
1818

19-
## [Features](@id doc_home_features)
19+
## [Features](@id doc_index_features)
2020

21-
#### [Features of Catalyst](@id doc_home_features_catalyst)
21+
#### [Features of Catalyst](@id doc_index_features_catalyst)
2222
- [The Catalyst DSL](@ref dsl_description) provides a simple and readable format for manually specifying reaction
2323
network models using chemical reaction notation.
2424
- Catalyst `ReactionSystem`s provides a symbolic representation of reaction networks,
@@ -52,7 +52,7 @@ etc).
5252
deterministic and stochastic terms within resulting ODE, SDE or jump models.
5353
- [Steady states](@ref homotopy_continuation) (and their [stabilities](@ref steady_state_stability)) can be computed for model ODE representations.
5454

55-
#### [Features of Catalyst composing with other packages](@id doc_home_features_composed)
55+
#### [Features of Catalyst composing with other packages](@id doc_index_features_composed)
5656
- [OrdinaryDiffEq.jl](https://github.com/SciML/OrdinaryDiffEq.jl) Can be used to numerically solver generated reaction rate equation ODE models.
5757
- [StochasticDiffEq.jl](https://github.com/SciML/StochasticDiffEq.jl) can be used to numerically solve generated Chemical Langevin Equation SDE models.
5858
- [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).
7979
[global sensitivity analysis](@ref global_sensitivity_analysis) of model behaviors.
8080
- [SciMLSensitivity.jl](https://github.com/SciML/SciMLSensitivity.jl) can be used to compute local sensitivities of functions containing forward model simulations.
8181

82-
#### [Features of packages built upon Catalyst](@id doc_home_features_other_packages)
82+
#### [Features of packages built upon Catalyst](@id doc_index_features_other_packages)
8383
- Catalyst [`ReactionSystem`](@ref)s can be [imported from SBML files](@id model_file_import_export_sbml) via
8484
[SBMLImporter.jl](https://github.com/SciML/SBMLImporter.jl) and [SBMLToolkit.jl](https://github.com/SciML/SBMLToolkit.jl),
8585
and [from BioNetGen .net files](@ref model_file_import_export_sbml_rni_net) and various stoichiometric matrix network representations
@@ -96,7 +96,7 @@ etc).
9696
- [BondGraphs.jl](https://github.com/jedforrest/BondGraphs.jl), a package for
9797
constructing and analyzing bond graphs models, which can take Catalyst models as input.
9898

99-
## [How to read this documentation](@id doc_home_documentation)
99+
## [How to read this documentation](@id doc_index_documentation)
100100
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).
101101

102102
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
126126
nothing # hide
127127
```
128128

129-
## [Installation](@id doc_home_installation)
129+
## [Installation](@id doc_index_installation)
130130
Catalyst is an officially registered Julia package, which can be installed through the Julia package manager:
131131
```julia
132132
using Pkg
@@ -142,9 +142,9 @@ is also needed.
142142

143143
A more throughout guide for setting up Catalyst and installing Julia packages can be found [here](@ref catalyst_for_new_julia_users_packages).
144144

145-
## [Illustrative example](@id doc_home_example)
145+
## [Illustrative example](@id doc_index_example)
146146

147-
#### [Deterministic ODE simulation of Michaelis-Menten enzyme kinetics](@id doc_home_example_ode)
147+
#### [Deterministic ODE simulation of Michaelis-Menten enzyme kinetics](@id doc_index_example_ode)
148148
Here we show a simple example where a model is created using the Catalyst DSL, and then simulated as
149149
an ordinary differential equation.
150150

@@ -170,7 +170,7 @@ sol = solve(ode)
170170
plot(sol; lw = 5)
171171
```
172172

173-
#### [Stochastic jump simulations](@id doc_home_example_jump)
173+
#### [Stochastic jump simulations](@id doc_index_example_jump)
174174
The same model can be used as input to other types of simulations. E.g. here we instead perform a
175175
jump simulation
176176
```@example home_simple_example
@@ -185,7 +185,7 @@ jump_sol = solve(jprob, SSAStepper(); seed = 1234) # hide
185185
plot(jump_sol; lw = 2)
186186
```
187187

188-
## [Elaborate example](@id doc_home_elaborate_example)
188+
## [Elaborate example](@id doc_index_elaborate_example)
189189
In the above example, we used basic Catalyst-based workflows to simulate a simple model. Here we
190190
instead show how various Catalyst features can compose to create a much more advanced model. Our
191191
model describes how the volume of a cell ($V$) is affected by a growth factor ($G$). The growth
@@ -230,13 +230,13 @@ sol = solve(sprob, EM(); dt = 0.05, seed = 1234) # hide
230230
plot(sol; xguide = "Time (au)", lw = 2)
231231
```
232232

233-
## [Getting Help](@id doc_home_help)
233+
## [Getting Help](@id doc_index_help)
234234
Catalyst developers are active on the [Julia Discourse](https://discourse.julialang.org/),
235235
the [Julia Slack](https://julialang.slack.com) channels \#sciml-bridged and \#sciml-sysbio, and the
236236
[Julia Zulip sciml-bridged channel](https://julialang.zulipchat.com/#narrow/stream/279055-sciml-bridged).
237237
For bugs or feature requests, [open an issue](https://github.com/SciML/Catalyst.jl/issues).
238238

239-
## [Supporting and Citing Catalyst.jl](@id doc_home_citation)
239+
## [Supporting and Citing Catalyst.jl](@id doc_index_citation)
240240
The software in this ecosystem was developed as part of academic research. If you would like to help
241241
support it, please star the repository as such metrics may help us secure funding in the future. If
242242
you use Catalyst as part of your research, teaching, or other activities, we would be grateful if you
@@ -257,7 +257,7 @@ could cite our work:
257257
}
258258
```
259259

260-
## [Reproducibility](@id doc_home_reproducibility)
260+
## [Reproducibility](@id doc_index_reproducibility)
261261
```@raw html
262262
<details><summary>The documentation of this SciML package was built using these direct dependencies,</summary>
263263
```

docs/src/inverse_problems/global_sensitivity_analysis.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -142,7 +142,7 @@ Here, the function's sensitivity is evaluated with respect to each output indepe
142142

143143
---
144144
## [Citations](@id global_sensitivity_analysis_citations)
145-
If you use this functionality in your research, [in addition to Catalyst](@ref catalyst_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](@ref doc_index_citation), please cite the following paper to support the authors of the GlobalSensitivity.jl package:
146146
```
147147
@article{dixit2022globalsensitivity,
148148
title={GlobalSensitivity. jl: Performant and Parallel Global Sensitivity Analysis with Julia},

docs/src/model_creation/model_file_loading_and_export.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,7 +136,7 @@ The advantage of these forms is that they offer a compact and very general way t
136136

137137
---
138138
## [Citations](@id petab_citations)
139-
If you use any of this functionality in your research, [in addition to Catalyst](@ref catalyst_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](@ref doc_index_citation), please cite the paper(s) corresponding to whichever package(s) you used:
140140
```
141141
@software{2022ReactionNetworkImporters,
142142
author = {Isaacson, Samuel},

docs/src/steady_state_functionality/dynamical_systems.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -124,7 +124,7 @@ More details on how to compute Lyapunov exponents using DynamicalSystems.jl can
124124

125125
---
126126
## [Citations](@id dynamical_systems_citations)
127-
If you use this functionality in your research, [in addition to Catalyst](@ref catalyst_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](@ref doc_index_citation), please cite the following paper to support the author of the DynamicalSystems.jl package:
128128
```
129129
@article{DynamicalSystems.jl-2018,
130130
doi = {10.21105/joss.00598},

docs/src/steady_state_functionality/nonlinear_solve.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -133,7 +133,7 @@ However, especially when the forward ODE simulation approach is used, it is reco
133133

134134
---
135135
## [Citations](@id nonlinear_solve_citation)
136-
If you use this functionality in your research, [in addition to Catalyst](@ref catalyst_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](@ref doc_index_citation), please cite the following paper to support the authors of the NonlinearSolve.jl package:
137137
```
138138
@article{pal2024nonlinearsolve,
139139
title={NonlinearSolve. jl: High-Performance and Robust Solvers for Systems of Nonlinear Equations in Julia},

docs/unpublished/petab_ode_param_fitting.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -523,7 +523,7 @@ There exist several types of plots for both types of calibration results. More d
523523

524524
---
525525
## [Citations](@id petab_citations)
526-
If you use this functionality in your research, [in addition to Catalyst](@ref catalyst_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](@ref doc_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:
527527
```
528528
@misc{2023Petabljl,
529529
author = {Ognissanti, Damiano AND Arutjunjan, Rafael AND Persson, Sebastian AND Hasselgren, Viktor},

0 commit comments

Comments
 (0)