GitHub

Development hints

Here, some development hints are given which mainly concern tests and documentation generation.

ReTest

ReTest.jl allows to run tests from a subset of testsets specified by regular expression. For the gemeral workflow, see the quick start documentation.

Testing the package code can be done just by calling test/runtests.jl. This file is also invoked by the CI, and it just includes test/alltests.jl.

Alternatively, test code can be run via ReTest. For this purpose, the module test/VoronoiFVMReTest.jl can be loaded in an environment with VoronoiFVM.jl (developed), test dependencies (see test/Project.toml), ReTest.jl and Revise.jl. A shared environment (e.g. via julia --project=@VoronoiFVM) is a convenient way to maintain such an environment locally.

After loading VoronoiFVM via ReTest as follows

julia> using ReTest
julia> ReTest.load("test/VoronoiFVMReTest.jl")

e.g.

julia> retest("Aqua")

runs just the "Aqua" testset. Via

julia> retest(dry=true)

one obtains a list of all possible testsets.

Pluto notebooks

The pluto notebooks in this package are "dual use":

  • If started from their position in the package hierarchy, they activate the docs environment, and thus automatically disable the Pluto package manager. This in particular is done during documentation generation where the PlutoStaticHTML package is used to run them and to generate HTML output from the result. Converting the package activation cell to Markdown re-enables the Pluto package manager, and triggers the creation of the typical Pluto inbuilt project and manifest files. However, at the moment, in this case, no package version compatibility check is performed.
  • During CI tests (including ReTest), they are run as scripts. For this purpose they are wrapped into temporary modules, and @test macros can be used in the notebooks.