add a Jupyter notebook tutorial version (#247)

JuliaDynamics · Nov 3, 2024 · 56b868c · 56b868c
1 parent d2a1579
commit 56b868c
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 5 deletions.
diff --git a/Project.toml b/Project.toml
@@ -1,7 +1,7 @@
 name = "DynamicalSystems"
 uuid = "61744808-ddfa-5f27-97ff-6e42cc95d634"
 repo = "https://github.com/JuliaDynamics/DynamicalSystems.jl.git"
-version = "3.3.24"
+version = "3.3.25"
 
 [deps]
 Attractors = "f3fd9213-ca85-4dba-9dfd-7fc91308fec7"

diff --git a/docs/Project.toml b/docs/Project.toml
@@ -3,17 +3,19 @@ Attractors = "f3fd9213-ca85-4dba-9dfd-7fc91308fec7"
 BenchmarkTools = "6e4b80f9-dd63-53aa-95a3-0cdb28fa8baf"
 CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
 ChaosTools = "608a59af-f2a3-5ad4-90b4-758bdf3122a7"
+ComplexityMeasures = "ab4b797d-85ee-42ba-b621-05d793b346a2"
 DelayEmbeddings = "5732040d-69e3-5649-938a-b6b4f237613f"
 DisplayAs = "0b91fe84-8a4c-11e9-3e1d-67c38462b6d6"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
+DynamicalSystems = "61744808-ddfa-5f27-97ff-6e42cc95d634"
 DynamicalSystemsBase = "6e36e845-645a-534a-86f2-f5d4aa5a06b4"
-ComplexityMeasures = "ab4b797d-85ee-42ba-b621-05d793b346a2"
+FractalDimensions = "4665ce21-e117-4649-aed8-08bbe5ccbead"
+GLMakie = "e9467ef8-e4e7-5192-8a1a-b1aee30e663a"
+Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 ModelingToolkit = "961ee093-0014-501f-94e3-6117800e7a78"
 OrdinaryDiffEq = "1dea7af3-3e70-54e6-95c3-0bf5283fa5ed"
 RecurrenceAnalysis = "639c3291-70d9-5ea2-8c5b-839eba1ee399"
 StateSpaceSets = "40b095a5-5852-4c12-98c7-d43bf788e795"
 Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
-FractalDimensions = "4665ce21-e117-4649-aed8-08bbe5ccbead"
-Literate = "98b081ad-f1c9-55d3-8b20-4c87d4299306"
 StochasticDiffEq = "789caeaf-c7a9-5a7d-9973-96adeb23e2a0"
diff --git a/docs/make.jl b/docs/make.jl
@@ -15,6 +15,10 @@ Literate.markdown(
     joinpath(@__DIR__, "src", "tutorial.jl"), joinpath(@__DIR__, "src");
     credit = false
 )
+Literate.notebook(
+    joinpath(@__DIR__, "src", "tutorial.jl"), joinpath(@__DIR__, "src");
+    credit = false, execute = true,
+)
 
 pages =  [
     "Introduction" => "index.md",

diff --git a/docs/src/tutorial.jl b/docs/src/tutorial.jl
@@ -1,12 +1,15 @@
 # # [Overarching tutorial for **DynamicalSystems.jl**](@id tutorial)
 
-# This page serves as a short but to-the-point introduction to the ****DynamicalSystems.jl****
+# This page serves as a short but to-the-point introduction to the **DynamicalSystems.jl**
 # library. It outlines the core components, and how they establish an interface that
 # is used by the rest of the library. It also provides a couple of usage examples
 # to connect the various packages of the library together.
 
 # Going through this tutorial should take you about 20 minutes.
 
+# !!! note "Also available as a Jupyter notebook"
+#     This tutorial is also available online as a [Jupyter notebook](https://github.com/JuliaDynamics/DynamicalSystems.jl/blob/gh-pages/dev/tutorial.ipynb).
+
 # ## Installation
 
 # To install **DynamicalSystems.jl**, simply do: