You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+14-19Lines changed: 14 additions & 19 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,14 +2,15 @@
2
2
3
3
This repository holds the material related with the textbook _Nonlinear Dynamics: A concise introduction interlaced with code_, co-authored by George Datseris and Ulrich Parlitz. This textbook will be published by Springer, in the series Undergraduate Lecture Notes in Physics, in 2021.
4
4
5
+
**Please do not open issues to ask questions on installing and running Julia or Julia packages, or questions on nonlinear dynamics in this repository.** Instead, open issues directly related with the book: found typos, problems with the source code contained here, suggestions for improvement of existing book sections, suggestions for new book sections, contributing new exercises, new multiple choice questions, etc. All contributions will be properly acknowledged whenever a new edition is out.
6
+
5
7
**Contents**
6
8
1.[Sample material](#sample-material)
7
9
2.[Tutorials for Julia and related packages](#tutorials-for-julia-and-related-packages)
6.[Interactive applications and videos](#interactive-applications-and-videos)
13
14
14
15
## Sample material
15
16
Sample material *(currently preliminary)* of the book is contained as `.pdf` in the `sample` folder.
@@ -18,22 +19,25 @@ Sample material *(currently preliminary)* of the book is contained as `.pdf` in
18
19
Below we provide links to various sources for learning Julia, or the packages that we use in the code snippets in the book.
19
20
20
21
-https://www.youtube.com/watch?v=Fi7Pf2NveH0 : Short-timed, intensive Julia workshop, that will teach everything necessary to use Julia. Aimed at people already familiar with programming
22
+
-https://www.youtube.com/watch?v=TJqOGsKQti8 : Short-timed introductory video for DynamicalSystems.jl
21
23
-https://juliadynamics.github.io/DynamicalSystems.jl/dev/ : Documentation of DynamicalSystems.jl
22
24
-https://juliadynamics.github.io/JuliaDynamics/ : Website of the JuliaDynamics organization
23
25
-https://www.youtube.com/watch?v=KPEqYtEd-zY : Introduction to solving differential equations in Julia, which is generally useful for nonlinear dynamics
24
-
-https://julialang.org/community/ : Resources for asking questions about Julia
26
+
-https://diffeq.sciml.ai/latest/ : Julia differential equations solving library
27
+
-https://julialang.org/community/ : Community resources about Julia
25
28
-https://discourse.julialang.org/ : Official Julia forum (and also the main platform that newcomers ask questions)
26
29
-https://github.com/rveltz/BifurcationKit.jl : Julia software for bifurcation analysis
27
30
31
+
28
32
## Reproducing figures
29
33
The accompanying code base used here is using the Julia Language and [DrWatson](https://juliadynamics.github.io/DrWatson.jl/stable/)
30
34
to make a reproducible environment that creates the figures of the book.
31
-
The code that creates the figures is in the `figure_generation` folder. Notice however that some figures were made with (or enhanced by) PowerPoint and thus we do not share this here.
35
+
The code that creates the figures is in the `figure_generation` folder. Notice however that some figures were made with (or enhanced by) PowerPoint and we do not share this here.
32
36
33
37
To (locally) reproduce a figure, first install Julia and then do the following:
34
38
35
39
0. Download this repository as-is and export it to some folder.
36
-
0. Install `DrWatson`on your general Julia installation by doing:
40
+
0. Install `DrWatson`in your general Julia installation by doing:
37
41
```
38
42
julia> using Pkg; Pkg.add("DrWatson")
39
43
```
@@ -42,12 +46,6 @@ To (locally) reproduce a figure, first install Julia and then do the following:
julia> Pkg.instantiate() # installs all packages used by the repo
44
48
```
45
-
1. This repository uses the Python library matplotlib (package `PyPlot`) for book plots and Makie.jl for the interactive applications. You could use any plotting package instead, but if you want to use `PyPlot` and replicate exactly the book plots, then run the following commands to ensure a working installation for all operating systems:
46
-
```
47
-
julia> ENV["PYTHON"] = ""
48
-
julia> Pkg.add("PyCall"); Pkg.build("PyCall")
49
-
julia> Pkg.add("PyPlot"); using PyPlot
50
-
```
51
49
52
50
Now all necessary packages are installed and all scripts should run out of the box.
53
51
As you will notice, all scripts start with the commands:
@@ -56,23 +54,20 @@ using DrWatson
56
54
@quickactivate "NonlinearDynamicsTextbook"
57
55
```
58
56
which ensures that only local directories will be used, as well as the *exact* package versions contained within the repository, leading to full reproducibility.
57
+
These package versions are also contained in the Project.toml and Manifest.toml files.
59
58
60
59
## Exercise datasets
61
60
The datasets that are used in the book exercises are contained in the `exercise_data` folder, all being in the same text-based format. To load the exercise data you only have to do:
62
61
```julia
63
62
using DelimitedFiles
64
-
X = readdlm("path/to/exercise_data/dataset.csv")
63
+
n =3# for the `n`-th dataset
64
+
X = readdlm(projectdir("exercise_data", "$n.csv"))
65
65
```
66
66
67
-
The same folder contains information of where this data is coming from: `data_explanations.md`. Some data are generated from simulations in the script `generating_code.jl`.
67
+
The same folder contains information of where this data is coming from: `data_explanations.md`.
68
68
69
69
## Multiple choice questions
70
70
Multiple choice questions that we use during lecturing to increase student involvement are in the `multiple_choice` folder.
71
71
72
-
## Interactive applications & videos
72
+
## Interactive applications and videos
73
73
In the folder `animations` we provide scripts that launch interactive applications, and also pre-recorded `.mp4` files for convenience.
74
-
75
-
## Contributing
76
-
Do you have suggestions for improving the contents? Perhaps you want to contribute something new, e.g. new exercises or multiple choice questions? Or perhaps you have a suggestion/comment on a book section? Or maybe you found a typo in the book?
77
-
78
-
Please do open an issue on this GitHub repository, and we'll take it into consideration for the next version!
0 commit comments