Catalyst.jl icon indicating copy to clipboard operation
Catalyst.jl copied to clipboard

Tutorials to add

Open ChrisRackauckas opened this issue 4 years ago • 6 comments

  • [ ] Scaling to large reaction networks: handling parallelism and sparsity
  • [ ] Choosing jump equation simulators
  • [ ] File I/O and reading in reaction networks
  • [ ] Getting back Exprs from the systems, saving models?
  • [x] Modifying systems and using the API to build systems.
  • [x] Time dependent rate and custom rate functions.
  • [x] Parameter estimation on network models.

ChrisRackauckas avatar Jul 19 '20 01:07 ChrisRackauckas

One thing we can really show over other packages is the ability to have a breadth of parameter estimation approaches using SciML tooling (maybe model component discovery too?). We should add tutorial(s) related to this (though I must admit that I'm not up on parameter estimation tooling, so I need to read up on this stuff).

isaacsas avatar Aug 03 '20 14:08 isaacsas

We should add a set of tutorials for Julia "beginners", for whom using Catalyst is one of their first Julia uses (I think we get a decent number of such users). We could then split the tutorials into "Julia Beginner" tutorials and "Experience Julia User" tutorials.

isaacsas avatar Apr 08 '22 22:04 isaacsas

Agreed, Catalyst will be the first package for many.

ChrisRackauckas avatar Apr 09 '22 00:04 ChrisRackauckas

Maybe the following "beginner" tutorials:

  • Introduction to using Catalyst (similar to what we have now).
  • Simulating Catalyst models using DifferentialEquations.jl (basically an intro guide to DiffEq simulations and plotting).
  • The reaction DSL (nothing there really requires additional Julia knowledge).
  • Basic chemical reaction network examples (Might be interesting for people who are familiar with these CRNs, but not with Julia).

And the rest would go into the second set of tutorials.

TorkelE avatar Apr 10 '22 09:04 TorkelE

Those sound good. The idea is the tutorials should explain basic Julia ideas as they go assuming little familiarity (like tuples vs. vectors for initial conditions, what a Pair is, etc).

isaacsas avatar Apr 11 '22 13:04 isaacsas

I think in that case, it might be better to just split it, and have a separate "Catalyst & Julia for Julia beginners" tutorial, possibly in several sections. And then we let the current ones remain more or less like they are, but assuming basic Julia knowledge.

TorkelE avatar Apr 13 '22 08:04 TorkelE

Closing as merged into https://github.com/SciML/Catalyst.jl/issues/515 to have one issue that tracks tutorials.

isaacsas avatar Mar 02 '23 20:03 isaacsas