All examples can be found as Julia scripts and Jupyter notebooks in a self-contained Julia project which is available here:
Once downloaded, extract the archive with your tool of choice. On Linux machines, you can run:
tar xzf examples.tar.gz
which will produce a folder in the same directory named "LyceumExamples". Inside, you'll find a
README.md, reproduced below, with further instructions.
Included in this project are all the examples found at LyceumDocs.jl, each available as either a
.jl script or Jupyter notebook. To start, open up a Julia REPL with the project activated by executing the following in the directory containing this README:
Now press the
] charcter to enter the Pkg REPL-mode. Your prompt should now look like this:
First, we'll add the LyceumRegistry so the package manager knows where to find the Lyceum packages:
(LyceumExamples) pkg> registry add https://github.com/Lyceum/LyceumRegistry.git Cloning registry from "https://github.com/Lyceum/LyceumRegistry.git" Added registry `LyceumRegistry` to `~/.julia/registries/LyceumRegistry` (LyceumExamples) pkg>
instantiate to download the required packages:
(LyceumExamples) pkg> instantiate Updating registry at `~/.julia/registries/General` Updating git-repo `https://github.com/JuliaRegistries/General.git` Updating registry at `~/.julia/registries/LyceumRegistry` Updating git-repo `https://github.com/Lyceum/LyceumRegistry.git` Cloning git-repo `https://github.com/Lyceum/Lyceum.jl.git` ...
You can now press
Backspace to exit Pkg REPL-mode, returning you to the regular REPL:
To run the Julia scripts, simply include them into your current session:
Alternative, you can run the notebooks using IJulia:
julia> using IJulia julia> notebook(dir="notebooks/"; detached=true)
The Jupyter notebook should open in your browser automatically. If not, go to http://localhost:8888/ in your browser of choice. From there you can browse and execute the various notebooks.
If you run into any trouble, don't hesitate to open an issue on the LyceumDocs.jl repo.