Skip to content
This repository was archived by the owner on May 9, 2024. It is now read-only.

Updating SunnyTutorials (Dev Note)

David A. Dahlbom edited this page Aug 21, 2023 · 1 revision

This repo is intended to host Jupyter notebook examples built from Literate files stored in the examples/longer_examples directory of the main Sunny.jl repository. The purpose of having a separate repository is to keep notebook builds out of the Sunny.jl git history.

To build the Literate files in the Sunny repo and host them on SunnyTutorials, simply call julia --project=@. make.jl inside the SunnyTutorials repo. The make script will

  • Pull all changes from the main Sunny.jl repo into the local copy of the repo (submodule) kept inside SunnyTutorials.
  • Use Literate.jl to build the examples as Jupyter notebooks
  • Push the resulting notebooks to the SunnyTutorial repo, where they will be publicly available.

By default, make.jl will built all the examples. If you only wish to build a single example, the script takes an optional file name, e.g., julia --project=@. make.jl [filename]. Note that this file must be located in the longer_examples directory of the main Sunny repo.

Clone this wiki locally