Skip to content

Commit c7fc7ef

Browse files
committed
BifurcationKit doc update
1 parent 6ee3c50 commit c7fc7ef

File tree

2 files changed

+25
-6
lines changed

2 files changed

+25
-6
lines changed

docs/src/catalyst_applications/bifurcation_diagrams.md

Lines changed: 23 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ We also bundle the information we have compiled so far into a
7272
using BifurcationKit, Plots, LinearAlgebra, Setfield
7373
7474
bprob = BifurcationProblem(F, oprob.u0, oprob.p, (@lens _[bif_idx]);
75-
recordFromSolution = (x, p) -> x[plot_idx], J = J)
75+
record_from_solution = (x, p) -> x[plot_idx], J = J)
7676
nothing # hide
7777
```
7878
Next, we need to specify the input options for the pseudo-arclength continuation
@@ -81,10 +81,10 @@ method (PACM) which produces the diagram.
8181
bopts = ContinuationPar(dsmax = 0.05, # Max arclength in PACM.
8282
dsmin = 1e-4, # Min arclength in PACM.
8383
ds = 0.001, # Initial (positive) arclength in PACM.
84-
maxSteps = 100000, # Max number of steps.
85-
pMin = p_span[1], # Min p-val (if hit, the method stops).
86-
pMax = p_span[2], # Max p-val (if hit, the method stops).
87-
detectBifurcation = 3) # Value in {0,1,2,3}
84+
max_steps = 100000, # Max number of steps.
85+
p_min = p_span[1], # Min p-val (if hit, the method stops).
86+
p_max = p_span[2], # Max p-val (if hit, the method stops).
87+
detect_bifurcation = 3) # Value in {0,1,2,3}
8888
nothing # hide
8989
```
9090
Here `detectBifurcation` determines to what extent bifurcation points are
@@ -111,6 +111,24 @@ capable of a lot more. For more details, please see that package's
111111
documentation:
112112
[BifurcationKit.jl](https://bifurcationkit.github.io/BifurcationKitDocs.jl/stable/).
113113

114+
---
115+
## [Citation](@id homotopy_continuation_citation)
116+
If you use this functionality in your research, please cite the following paper to support the author of the BifurcationKit package:
117+
```
118+
@misc{veltz:hal-02902346,
119+
title = {{BifurcationKit.jl}},
120+
author = {Veltz, Romain},
121+
url = {https://hal.archives-ouvertes.fr/hal-02902346},
122+
institution = {{Inria Sophia-Antipolis}},
123+
year = {2020},
124+
month = Jul,
125+
keywords = {pseudo-arclength-continuation ; periodic-orbits ; floquet ; gpu ; bifurcation-diagram ; deflation ; newton-krylov},
126+
pdf = {https://hal.archives-ouvertes.fr/hal-02902346/file/354c9fb0d148262405609eed2cb7927818706f1f.tar.gz},
127+
hal_id = {hal-02902346},
128+
hal_version = {v1},
129+
}
130+
```
131+
114132
---
115133
## References
116134
[^1]: [Yuri A. Kuznetsov, *Elements of Applied Bifurcation Theory*, Springer (2023).](https://link.springer.com/book/10.1007/978-3-031-22007-4)

docs/src/catalyst_applications/homotopy_continuation.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -61,8 +61,8 @@ hc_steady_states(two_state_model, ps; u0)
6161
- `hc_steady_states` supports any systems where all rates are systems of rational polynomials (such as Hill functions with integer Hill coefficients).
6262
- When providing initial conditions to compute conservation laws, values are only required for those species that are part of conserved quantities. If this set of species is unknown, it is recommended to provide initial conditions for all species.
6363
- Additional arguments provided to `hc_steady_states` are automatically passed to HomotopyContinuation's `solve` command. Use e.g. `show_progress=false` to disable the progress bar.
64-
---
6564

65+
---
6666
## [Citation](@id homotopy_continuation_citation)
6767
If you use this functionality in your research, please cite the following paper to support the authors of the HomotopyContinuation package:
6868
```
@@ -76,6 +76,7 @@ If you use this functionality in your research, please cite the following paper
7676
}
7777
```
7878

79+
---
7980
## References
8081
[^1]: [Thomas Wilhelm, *The smallest chemical reaction system with bistability*, BMC Systems Biology (2009).](https://bmcsystbiol.biomedcentral.com/articles/10.1186/1752-0509-3-90)
8182
[^2]: [Paul Breiding, Sascha Timme, *HomotopyContinuation.jl: A Package for Homotopy Continuation in Julia*, International Congress on Mathematical Software (2018).](https://link.springer.com/chapter/10.1007/978-3-319-96418-8_54)

0 commit comments

Comments
 (0)