This is the ReactiveBayes template for a Julia package. It is a working package with one example function: tests with TestItemRunner, Aqua and JET, a documentation site with Documenter, benchmarks with PkgBenchmark, Runic formatting, and CI, documentation, CompatHelper and TagBot set up.
Writing message passing rules? Start from MessagePassingRulesTemplate.jl instead: it is laid out as every rule package is, with an example node and its tests.
- Use this template → Create a new repository, named
<Name>.jl.- Clone it and run, from its root,
julia setup.jl <Name>(--owner <GitHub owner>, defaultReactiveBayes;--author "Name <email>"). It renames the package, gives it a new UUID and links, and prints the steps left: the documentation key, GitHub Pages and registration.- Replace the example function,
greet, with your code, its tests and its documentation.make testandmake docscheck them as CI does.Everything between these lines disappears with
setup.jl.
Replace this paragraph with what your package does.
import Pkg; Pkg.add("PkgName")- Documentation: https://reactivebayes.github.io/PackageTemplate/dev/.
make docsbuilds it locally, intodocs/build. - Tests:
make testruns the suite as CI does;make test test_args="tag:quality"selects items by tag, by name or by file.make helplists the other targets:format,check-format,benchmark,docs-serve. - Julia 1.10 or later. MIT licence.