Closed Saityi closed 2 months ago
Just a remark that the “official” way to accomplish what you’re doing here is with Literate.jl, which will generate Documenter files, notebooks, and scripts from the same markdown source, if you find that shell script inconvenient to maintain at some point.
Issue
Our notebook examples easily go out of date, and it's hard to notice when it happens without a regular CI checking them
Fix
Convert notebook examples to Julia code and run them
Fix errors CI exposed:
Graph
was removed fromvisualization.jl
, but was used by examples, especially older onesClOUD
->CLOUD
Graph
->GraphCL
Pkg.activate('../../../')
in a causal loop exampleNotes
Includes commits from #131 and verifies removing
GraphViz
did not break any examples. @KevinDCarlsonAlso addresses https://github.com/AlgebraicJulia/StockFlow.jl/issues/113#issuecomment-1861809454
Misc
Aqua.jl
around non-existent exportsfull_fledged_schema_examples/CaulsalLoopDiagrams
tofull_fledged_schema_examples/CausalLoopDiagrams
These tests can be run locally by running the helper script,
validate-notebook-examples.sh
, which does what the workflow does:TODO
Graph
and what our 'display' API looks like going into a full initial 1.0Threads.@threads
on the for loop in the test runner, but was getting strange errors:Reason: LoadError: package StockFlow did not define the expected module StockFlow, check for typos in package module name