Contributing

Installation

Use the Pkg interface

pkg> add https://github.com/stephen-huan/SparseKoLesky.jl

Tests may be ran through the standard Pkg.test() interface

pkg> test

The files in examples may be ran like

julia --project="@." examples/main.jl

This project is formatted in the Blue style with JuliaFormatter.jl. The current configuration is

style = "blue"
margin = 79

The entire project may be styled with a command like

julia \
  --project="@." \
  --eval "using JuliaFormatter; format(\".\")"

or the provided /bin/juliafmt utility.

./bin/juliafmt .

Documentation is based on Julia docstrings and Documenter.jl. To locally preview the documentation, run

./bin/build && ./bin/serve

and open http://localhost:8000/ in a web browser.

To push the built site to the cloudflare-pages branch, run

./bin/publish

Markdown files should be styled with Prettier.