deactivate notebook generation

JuliaReach · Feb 6, 2024 · 6afb59f · 6afb59f
1 parent 345c01d
commit 6afb59f
Show file tree

Hide file tree

Showing 20 changed files with 5 additions and 21 deletions.
diff --git a/docs/generate.jl b/docs/generate.jl
@@ -42,7 +42,11 @@ for model in MODELS
                 # for the local build, one needs to set `nbviewer_root_url`
                 Literate.markdown(input, target_dir_md; postprocess=mdpost, credit=false, nbviewer_root_url="..")
             end
-            Literate.notebook(input, target_dir_md; execute=true, credit=false)
+
+            # notebooks are deactivated to speed up the generation
+#             Literate.notebook(input, target_dir_md; execute=true, credit=false)
+# if used, add the following to the top of the script files (where `MODELNAME` is the model name):
+#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/MODELNAME.ipynb)
         elseif any(endswith.(file, [".jld2", ".png"]))
             # ignore *.jld2 and *.png files without warning
         else

diff --git a/examples/Brusselator/Brusselator.jl b/examples/Brusselator/Brusselator.jl
@@ -1,5 +1,4 @@
 # # Brusselator
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/Brusselator.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: polynomial continuous system\

diff --git a/examples/Building/Building.jl b/examples/Building/Building.jl
@@ -1,5 +1,4 @@
 # # Building
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/Building.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: Affine system\

diff --git a/examples/DuffingOscillator/DuffingOscillator.jl b/examples/DuffingOscillator/DuffingOscillator.jl
@@ -1,5 +1,4 @@
 # # Duffing Oscillator
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/DuffingOscillator.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: nonlinear\

diff --git a/examples/EMBrake/EMBrake.jl b/examples/EMBrake/EMBrake.jl
@@ -1,5 +1,4 @@
 # # Electromechanic break
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/EMBrake.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: Affine system\

diff --git a/examples/Heat3D/Heat3D.jl b/examples/Heat3D/Heat3D.jl
@@ -1,5 +1,4 @@
 # # Heat PDE
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/Heat3D.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: Affine system\

diff --git a/examples/ISS/ISS.jl b/examples/ISS/ISS.jl
@@ -1,5 +1,4 @@
 # # Structural Model
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/ISS.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: linear time-invariant continuous system\

diff --git a/examples/LaubLoomis/LaubLoomis.jl b/examples/LaubLoomis/LaubLoomis.jl
@@ -1,5 +1,4 @@
 # # Laub-Loomis
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/LaubLoomis.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: polynomial with quadratic nonlinearities\

diff --git a/examples/Lorenz/Lorenz.jl b/examples/Lorenz/Lorenz.jl
@@ -1,5 +1,4 @@
 # # Lorenz equations
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/Lorenz.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: Continuous blackbox system\

diff --git a/examples/LotkaVolterra/LotkaVolterra.jl b/examples/LotkaVolterra/LotkaVolterra.jl
@@ -1,5 +1,4 @@
 # # Lotka-Volterra
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/LotkaVolterra.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: Nonlinear system\

diff --git a/examples/LotkaVolterraTangential/LotkaVolterraTangential b/examples/LotkaVolterraTangential/LotkaVolterraTangential
@@ -1,5 +1,4 @@
 # # Lotka-Voltera with Nonlinear Guard
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/LotkaVolterraGuard.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: hybrid system with nonlinear guard\

diff --git a/examples/OpAmp/OpAmp.jl b/examples/OpAmp/OpAmp.jl
@@ -1,5 +1,4 @@
 # # Amplifier circuit
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/OpAmp.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: linear continuous system with piecewise-linear input\

diff --git a/examples/Platoon/Platoon.jl b/examples/Platoon/Platoon.jl
@@ -1,5 +1,4 @@
 # # Vehicle Platoon Model
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/Platoon.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: affine with hybrid dynamics\

diff --git a/examples/ProductionDestruction/ProductionDestruction.jl b/examples/ProductionDestruction/ProductionDestruction.jl
@@ -1,5 +1,4 @@
 # # Production-Destruction
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/ProductionDestruction.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: rational function\

diff --git a/examples/Quadrotor/Quadrotor.jl b/examples/Quadrotor/Quadrotor.jl
@@ -1,5 +1,4 @@
 # # Quadrotor
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/Quadrotor.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: polynomial continuous system\

diff --git a/examples/SEIR/SEIR.jl b/examples/SEIR/SEIR.jl
@@ -1,5 +1,4 @@
 # # SEIR
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/SEIR.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: Nonlinear system\

diff --git a/examples/Spacecraft/Spacecraft.jl b/examples/Spacecraft/Spacecraft.jl
@@ -1,5 +1,4 @@
 # # Spacecraft
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/Spacecraft.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: hybrid system with nonlinear dynamics\

diff --git a/examples/SquareWaveOscillator/SquareWaveOscillator.jl b/examples/SquareWaveOscillator/SquareWaveOscillator.jl
@@ -1,5 +1,4 @@
 # # Square Wave Oscillator
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/SquareWaveOscillator.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: linear hybrid\

diff --git a/examples/TransmissionLine/TransmissionLine.jl b/examples/TransmissionLine/TransmissionLine.jl
@@ -1,7 +1,5 @@
 # # Transmission line circuit
 #
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/TransmissionLine.ipynb)
-#
 #md # !!! note "Overview"
 #md #     System type: linear continuous system\
 #md #     State dimension: parametric, typically between 4 to 40\

diff --git a/examples/VanDerPol/VanDerPol.jl b/examples/VanDerPol/VanDerPol.jl
@@ -1,5 +1,4 @@
 # # Van der Pol oscillator
-#md # [![](https://img.shields.io/badge/show-nbviewer-579ACA.svg)](@__NBVIEWER_ROOT_URL__/generated_examples/VanDerPol.ipynb)
 #
 #md # !!! note "Overview"
 #md #     System type: polynomial continuous system\