`DynamicalSystems`

— Module**DynamicalSystems.jl** is an award-winning Julia-based general-purpose software library for the whole of nonlinear dynamics and nonlinear timeseries analysis.

To install **DynamicalSystems.jl**, run `import Pkg; Pkg.add("DynamicalSystems")`

as a Julia language command. To learn how to use it and see its contents visit the documentation, which you can either find online or build locally by running the `docs/make.jl`

file.

**DynamicalSystems.jl** is part of JuliaDynamics, an organization dedicated to creating high quality scientific software.

**Highlights**

Aspects of **DynamicalSystems.jl** that make it stand out among other codebases for nonlinear dynamics or nonlinear timeseries analysis are:

**Exceptional documentation**. All implemented algorithms provide a high-level scientific description of their functionality in their documentation string as well as references to scientific papers. The documentation features hundreds of tutorials and examples ranging from introductory to expert usage.**Accessible source code**. One of the main priorities of the library is that the source code of (almost) all implementations is small, simple, easy to understand and modify. This increases confidence, reduces bugs, and allows users to become developers without unnecessary effort.**Open source community project**. Built from the ground up entirely on GitHub,**DynamicalSystems.jl**is 100% open source and based on community contributions. Anyone can be a developer of the library. Everyone is welcomed.**Extensive content**. It aims to cover the entire field of nonlinear dynamics and nonlinear timeseries analysis. It has functionality for complexity measures, delay embeddings, periodic orbits, nonlocal stability analysis, continuation, chaos, fractal dimensions, surrogate testing, recurrence quantification analysis, and much more. Furthermore, all algorithms are "general" and work for any dynamical system applicable. Missing functionality that falls under this wide category of content is welcomed to be part of the library!**Well tested**. All implemented functionality is extensively tested. Each time any change in the code base is done, the extensive test suite is run and checked before merging the change in.**Extendable**. New contributions can become part of the library and be accessed by all users in the next release. Most importantly, all parts of the library follow professional standards in software design and implement extendable interfaces so that it is easy to contribute new functionality.**Active development**. It is a living, evolving project. Since its beginning in May 2017,**DynamicalSystems.jl**has had some activity every single month: new features, bugfixes. The developer team routinely answers users questions on official Julia language forums.**Performant**. Written entirely in Julia, heavily optimized and parallelized, and taking advantage of some of the best packages within the language,**DynamicalSystems.jl**is*really fast*.

**Goals**

The **DynamicalSystems.jl** library started as a vision with three main goals; These same goals now are the core pillars guiding development, and are largely the source of where the aforementioned unique highlights stem from.

**Goal 1: Accessible and reproducible nonlinear dynamics**

The first goal of the library is to make this beautiful field **accessible and reproducible**.

**Accessible** means that if you read on some sorts of fancy algorithm online in a scientific article, you should be able to use it instantly. You shouldn't have to put in the work to code it yourself. The authors of the paper already did that. *So why should you do it again?!* To resolve this problem we developed, and continue to develop, a library that has an incredibly low threshold of entry: contributing to **DynamicalSystems.jl** and making your code available to all is truly *easier* than coding your own algorithms from scratch, due to the well thought out and generic interfaces it provides for dynamical systems.

**Reproducible** means that given some sorts of dynamical systems analysis in a scientific article, you should be able to do *exactly the same analysis* and get *exactly the same results* (within some numeric precision) as the article. After all, computers are deterministic constructs. **DynamicalSystems.jl** allows this by (1) being written in a modern programming language with incredible environment and reproducibility support, (2) being well tested, and (3) by providing thousands of algorithms out of the box, allowing most dynamical systems analysis to be done instantly while implementing only as little new stuff as necessary.

**Goal 2: Library in the literal sense**

**DynamicalSystems.jl** is not just a software library. It is also a library in the literal sense: *where people go to learn something new* (here in particular for nonlinear dynamics). That is why the documentation is of exceptionally high quality: detailed descriptions and explanations of algorithms, with references to the scientific articles articles. It is also partly a reason for the source code to be written as clearly as possible, so that it is examinable by any user.

**Goal 3: A general purpose software**

The third goal is to fill the missing gap of a high quality *general purpose software* for nonlinear dynamics which can be easily extended with new functionality. This can be particularly impactful in teaching. You see, it is unfortunately rarely the case that real, *runnable* code is shown in the classroom, because it is often long and messy. This is especially hurtful for nonlinear dynamics, a field where computer-assisted exploration is critical.

**DynamicalSystems.jl** provides teachers with a framework capable of demonstrating actual, real-world nonlinear dynamics code and its output, without having to invest the weeks to code the internal infrastructure themselves. Its high level syntax requires writing little code to get lots of meaningful analysis done, while its extensive functionality covers most typical classroom applications.

If you have found this library useful, please consider starring it on GitHub. This gives us an accurate lower bound of the (satisfied) user count.

## Introduction

Welcome to the documentation of **DynamicalSystems.jl**!

- If you have not used the library before, and would like to get started, then please read the overarching tutorial for the library.
- The contents page gives a summary of all packages that are part of the library.
- See the learning resources below to find out more resources about learning the library and using it in scientific research and/or education.
- Besides the formal algorithmic/scientific content of
**DynamicalSystems.jl**(those in the contents) page, the library also provides basic functionality for interactive or offline animations and visualizations. These are found in the visualizations page. - The remaining of this introduction page discusses our goals with the library, how to participate as a user or developer, how to cite, and other relevant information (see the sections of the sidebar on the left).

## Latest news

All subpackages composing DynamicalSystems.jl have their own human-readable CHANGELOG files in their corresponding GitHub repositories. The CHANGELOGs log all meaningful changes in the software.

Notable news for the **DynamicalSystems.jl** library are also posted on the official Julia language Discourse, and users may subscribe to this particular Topic to get notified of updates:

https://discourse.julialang.org/t/dynamicalsystems-jl-news-updates-and-announcements/122079

## Learning resources

### Textbook with DynamicalSystems.jl

We have written an undergraduate level textbook as an introduction to nonlinear dynamics. The text is written in an applied, hands-on manner, while still covering all fundamentals. The book pages are interlaced with real Julia code that uses DynamicalSystems.jl and is published in the Undergraduate Lecture Notes in Physics by Springer Nature:

- Nonlinear Dynamics: A concise introduction interlaced with code by G. Datseris & U. Parlitz.

Additional textbooks on nonlinear dynamics with practical focus are:

- Chaos in Dynamical Systems - E. Ott
- Nonlinear Time series Analysis - H. Kantz & T. Schreiber
- Nonlinear Dynamics and Chaos - S. Strogatz

### Course on applied nonlinear dynamics and complex systems

We are developing a full course (targeting a graduate or undergraduate semester long course) on applied nonlinear dynamics, nonlinear timeseries analysis, and complex systems, using the packages of JuliaDynamics. **DynamicalSystems.jl** is part of this course.

The materials of the course are on GitHub: https://github.com/JuliaDynamics/NonlinearDynamicsComplexSystemsCourses

## Citing

There is a (small) paper associated with **DynamicalSystems.jl**. If we have helped you in research that led to a publication, please cite it using the DOI `10.21105/joss.00598`

or the following BiBTeX entry:

```
@article{Datseris2018,
doi = {10.21105/joss.00598},
url = {https://doi.org/10.21105/joss.00598},
year = {2018},
month = {mar},
volume = {3},
number = {23},
pages = {598},
author = {George Datseris},
title = {DynamicalSystems.jl: A Julia software library for chaos and nonlinear dynamics},
journal = {Journal of Open Source Software}
}
```

Irrespectively of **DynamicalSystems.jl**, *please also cite the specific algorithm that you used from the library*. The documentation of the function used will point you to the correct reference.

Besides the library, we would also appreciate it if you cited the textbook we wrote that **DynamicalSystems.jl** accompanies:

```
@book{DatserisParlitz2022,
doi = {10.1007/978-3-030-91032-7},
url = {https://doi.org/10.1007/978-3-030-91032-7},
year = {2022},
publisher = {Springer Nature},
author = {George Datseris and Ulrich Parlitz},
title = "Nonlinear dynamics: A concise introduction interlaced with code",
address = "Cham, Switzerland",
language = "en",
}
```

## Asking questions

There are three options for asking questions:

- As a new post in the official Julia discourse and ask a question under the category Specific Domains > Modelling & Simulations, also using
`dynamical-systems`

as a tag. This option is preferred for any meaningfully involved question, as the answer there will be future-searchable. - As a message in our channel
`#dynamics-bridged`

in the Julia Slack workplace. This option is preferred for a brief question with (expected) simple answer, or to get an opinion about something, or to chat about something. - By opening an issue directly on the GitHub page of DynamicalSystems.jl while providing a Minimal Working Example. This option is preferred when you encounter unexpected behavior.

## Contributing & Donating

Be sure to visit the Contributor Guide page, because you can help make this package better without having to write a single line of code! Also, if you find this package helpful please consider staring it on GitHub! This gives us an accurate lower bound of users that this package has already helped!

Finally, you can donate for the development of **DynamicalSystems.jl**. You can do that by adding bounties to existing issues on the GitHub repositories (you can open new issues as well). Every issue has an automatic way to create a bounty using Bountysource, see the first comment of each issue.

### Issues with Bounties

Money that **DynamicalSystems.jl** obtains from awards, sponsors, or donators are converted into bounties for GitHub issues. The full list of issues that have a bounty is available here.

By solving these issues you not only contribute to open source, but you also get some pocket money to boot :)

## Maintainers and Contributors

The **DynamicalSystems.jl** library is maintained by George Datseris, who is also curating and writing this documentation. The software code however is built from the contributions of several individuals. The list is too long to write and constantly update, so the best way to find out these contributions is to visit the GitHub page of each of the subpackages and checkout the "contributors" pages there.

## Version numbers

The version of `DynamicalSystems`

by itself is a bit meaningless, because the module does not have any source code, besides re-exporting other modules. For transparency, the packages and versions used to build the documentation you are reading now are:

```
using Pkg
Pkg.status([
"DynamicalSystems",
"StateSpaceSets", "DynamicalSystemsBase", "RecurrenceAnalysis", "FractalDimensions", "DelayEmbeddings", "ComplexityMeasures", "TimeseriesSurrogates", "PredefinedDynamicalSystems", "Attractors", "ChaosTools", "CairoMakie",
];
mode = PKGMODE_MANIFEST
)
```

```
Status `~/work/DynamicalSystems.jl/DynamicalSystems.jl/docs/Manifest.toml`
[f3fd9213] Attractors v1.22.1
[13f3f980] CairoMakie v0.12.15
[608a59af] ChaosTools v3.2.1
[ab4b797d] ComplexityMeasures v3.7.1
[5732040d] DelayEmbeddings v2.8.0
[61744808] DynamicalSystems v3.3.24 `~/work/DynamicalSystems.jl/DynamicalSystems.jl`
[6e36e845] DynamicalSystemsBase v3.11.2
[4665ce21] FractalDimensions v1.9.0
[31e2f376] PredefinedDynamicalSystems v1.2.0
[639c3291] RecurrenceAnalysis v2.1.0
[40b095a5] StateSpaceSets v2.3.0
[c804724b] TimeseriesSurrogates v2.7.2
```

Because of the nature of the **DynamicalSystems.jl** library, the exported API contains hundreds of algorithm implementations, most of which are independent of each other. Our development approach is that breaking changes to these individual algorithms (due to e.g., better API design or better performance implementations or better default keyword arguments) can be done **without incrementing any major version numbers**. We increment major version numbers only for breaking changes that have wide impact over most of the **DynamicalSystems.jl** library.

## Other NLD-relevant packages

Besides DynamicalSystems.jl, the Julia programming language has a thriving ecosystem with plenty of functionality that is relevant for nonlinear dynamics. We list some useful references below:

- DifferentialEquations.jl - Besides providing solvers for standard ODE systems (infastructure already used in DynamicalSystems.jl), it also has much more features like SDE solvers or uncertainty quantification.
- SciMLSensitivity.jl - Discrete and continuous local sensitivity analysis, i.e., derivatives of the solutions of ODEs, or functions of the solutions, versus parameters, hosting various forward and adjoint methods as well as methods tailored to chaotic systems.
- GlobalSensitivity.jl - Global sensitivity analysis assessing the effect of any input variables over a larger domain on the output.
- BifurcationKit.jl - Featureful toolkit for automated bifurcation analysis.
- NetworkDynamics.jl - Simulating dynamics on networks and transforming network systems into
`ODEProblem`

(that can be made directly into a`ContinuousDynamicalSystem`

). - Agents.jl - Agent based modelling.
- EasyModelAnalysis.jl - Analysis tools for conveniently analysing solutions of DiffEq systems.
- SignalDecomposition.jl - Decompose a signal/timeseries into structure and noise or seasonal and residual components.
- ARFIMA.jl - generate ARFIMA process timeseries.
- ConcurrentSim.jl - discrete event process oriented simulation framework.
- CausalityTools.jl - hundreds of algorithms for relational/causal timeseries analysis and causal graphs.