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

Add example for getting name of species/parameters

Open oxinabox opened this issue 3 months ago • 4 comments

Checklist

  • [x] Appropriate tests were added
  • [x] Any code changes were done in a way that does not break public API
  • x ] All documentation related to code changes were updated
  • [x] The new code follows the contributor guidelines, in particular the SciML Style Guide and COLPRAC.
  • [ ] Any new documentation only uses public API ??? idk

Additional context

Closes https://github.com/SciML/Catalyst.jl/issues/1325

oxinabox avatar Oct 01 '25 02:10 oxinabox

Looks good. In practise the section probably doesn't really belong in the DSL bit. The best would probably be to list this and other relavant functions in the API after this: https://docs.sciml.ai/Catalyst/stable/api/core_api/#Basic-species-properties, and then we can link to it after where we introduce symbolic variables (e.g. here and here).

Not suggesting that you have to do it, happy to add it myself.

TorkelE avatar Oct 01 '25 06:10 TorkelE

yeah i thought about putting it there but couldn't workout exactly where it fit neatly

oxinabox avatar Oct 01 '25 07:10 oxinabox

yeah, the docs have grown a lot so it is quite hard to figure out, but now we have the text which is the important bit. I'll push changes to this PR and finish it of (if you are happy with that).

TorkelE avatar Oct 01 '25 07:10 TorkelE

sounds good

oxinabox avatar Oct 01 '25 07:10 oxinabox