BcubeTutorials.jl

Documented tutorials and various examples for the Bcube.jl project. Browse the online documentation.

Run the scripts locally

All the tutorials can be ran locally with the following steps.

First, clone the repository

$ git clone https://github.com/bcube-project/BcubeTutorials.jl.git
$ cd BcubeTutorials.jl/

Then, set up the environnement and run the script.

pkg> activate .
(BcubeTutorials) pkg> instantiate
julia> include("src/tutorial/helmholtz.jl")

Regarding the examples, some of them require additionnal dependencies. Hence each example is associated to a specific environment:

julia> cd("src/example/covo")
julia> using Pkg
julia> Pkg.activate(".")
julia> Pkg.add(PackageSpec(url="https://github.com/bcube-project/Bcube.jl"))
julia> Pkg.instantiate()
julia> include("covo.jl")

Build the documentation

To browse the online documentation, simply click on the blue badge at the top of this README. If you would like to build the documentation yourself, for an offline access for instance, you can do it with the following commands.

$ git clone https://github.com/bcube-project/BcubeTutorials.jl.git
$ cd BcubeTutorials.jl

pkg> activate .
(BcubeTutorials) pkg> instantiate
julia> include("docs/make.jl")

You can then browse BcubeTutorials.jl/docs/build/index.html.

Authors

Ghislain Blanchard, Lokman Bennani and Maxime Bouyges.