SunnySuite / Sunny.jl

Spin dynamics and generalization to SU(N) coherent states
Other
86 stars 19 forks source link

Code coverage #117

Open kbarros opened 1 year ago

kbarros commented 1 year ago

It would be nice to know how much of Sunny our test suite is actually testing, and maybe include a badge on the Github repo. Apparently there are a lot of Julia tools for this. To generate .cov files, use:

Pkg.test("Sunny"; coverage=true)

Maybe a better way to explore is LocalCoverage.jl. Some explanation here: https://tamaspapp.eu/post/julia-local-coverage/

For example,

using LocalCoverage
generate_coverage("Sunny"; genhtml=true, show_summary=true, genxml=false) # defaults shown
open_coverage("Sunny")
# then, eventually
clean_coverage(pkg; rm_directory=true)

This issue might relevant: https://github.com/JuliaCI/LocalCoverage.jl/issues/31