suggestions for documentation improvement
slwu89 opened this issue · comments
Just collecting some things I found confusing that I plan to make one or more PRs to address in the future
- docs for
oapply_typeddo not say what the purpose of the 3rd argument (Vector{Symbol}) is; update docstring - extra
rat start ofadd_reflexivesdocstring prevents it from working - it would be nice to describe somewhere what an open PN is and at least the very basics of how to work with the multicospans one gets from using them
- it would be nice to show how to combine 2 UWDs into a larger UWD using the categorical interface (probably just implement this https://algebraicjulia.github.io/AlgebraicDynamics.jl/stable/examples/Ecosystem/#Rabbits,-foxes,-and-hawks)
- improve the main README.md file to give more information, a few pictures, a link to the Royal Society paper, maybe relevant ACT conf recordings, and background (need to discuss this with the maintainer)
- typed product of sird_model and mask_model in the stratification tutorial gives an incorrect model
- is there a way to improve the construction of the "mask-vax model" UWD (https://algebraicjulia.github.io/AlgebraicPetri.jl/stable/generated/covid/stratification/#Mask-Vax-Model)? It exhibits many of the problems that the categorical approach hopes to avoid (tedious code with only minor changes between lines).
- expand the ecological examples to include the lotka-volterra equations for
nspecies: https://en.wikipedia.org/wiki/Competitive_Lotka%E2%80%93Volterra_equations