Skip to content

Commit bd8c5a5

Browse files
committed
better wordin for tutorial and correct versioning
1 parent bd2c388 commit bd8c5a5

File tree

2 files changed

+15
-9
lines changed

2 files changed

+15
-9
lines changed

Project.toml

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
name = "DynamicalSystems"
22
uuid = "61744808-ddfa-5f27-97ff-6e42cc95d634"
33
repo = "https://github.com/JuliaDynamics/DynamicalSystems.jl.git"
4-
version = "3.3.19"
4+
version = "3.3.20"
55

66
[deps]
77
Attractors = "f3fd9213-ca85-4dba-9dfd-7fc91308fec7"

docs/src/tutorial.jl

+14-8
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,9 @@
11
# # [Overarching tutorial for DynamicalSystems.jl](@id tutorial)
22

3-
#nb @doc DynamicalSystems
4-
5-
# 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.
3+
# This page serves as a short but to-the-point introduction to the **DynamicalSystems.jl**
4+
# library. It outlines the core components, and how they establish an interface that
5+
# is used by the rest of the library. It also provides a couple of usage examples
6+
# to connect the various packages of the library together.
67

78
# Going through this tutorial should take you about 20 minutes.
89

@@ -13,10 +14,12 @@
1314
# using Pkg; Pkg.add("DynamicalSystems")
1415
# ```
1516

16-
# As discussed in the [contents](@ref contents) page, this installs several packages for the Julia language, that are all exported under a common name. To use them, simply do:
17-
# ```julia
18-
# using DynamicalSystems
19-
# ```
17+
# This installs several packages for the Julia language. These are the sub-modules/packages
18+
# that comprise DynamicalSystems.jl, see [contents](@ref contents) for more.
19+
# All of the functionality is brought into scope when doing:
20+
21+
using DynamicalSystems
22+
2023
# in your Julia session.
2124

2225
# ### Package versions used
@@ -26,9 +29,12 @@ import Pkg
2629
#nb # Activate an environment in the folder containing the notebook
2730
#nb Pkg.activate(dirname(@__DIR__))
2831
#nb Pkg.add(["DynamicalSystems", "CairoMakie", "GLMakie", "OrdinaryDiffEq", "BenchmarkTools"])
29-
3032
Pkg.status(["DynamicalSystems", "CairoMakie", "GLMakie", "OrdinaryDiffEq", "BenchmarkTools"]; mode = Pkg.PKGMODE_MANIFEST)
3133

34+
#nb # ## DynamicalSystems.jl summary
35+
36+
#nb @doc DynamicalSystems
37+
3238
# ## Core components
3339

3440
# The individual packages that compose `DynamicalSystems` interact flawlessly with each other because of the following two components:

0 commit comments

Comments
 (0)