search

JuliaDynamics / Attractors.jl

Find attractors of dynamical systems, their basins, and continue them across parameters. Study global stability (a.k.a. non-local, or resilience). Also tipping points functionality.
MIT License
27 stars 5 forks source link

Dedicated tutorial / superseedes #128 #129

Closed Datseris closed 1 week ago

Datseris commented 1 week ago

This a continuation / superseeding of #128. The new example becomes a main tutorial, which guides through the main library features.

I've changed the documentation layout, so that the API is not separated across many doc pages, but resides in a single API page. I don't know whether this is good or bad, but with the presence of the Tutorial, having several different pages for the API functions felt disconnecting to me.

In this PR I've removed this nice flowchart figure we had (taken from our paper). The reason was: it is hard to maintain, if anything new is added to the library, then we can't really update the figure via standard Julia commands. The second reason: it doesn't cover other things in the library like edgestates, fractal basins, etc...

@awage @kalelR I would really appreciate this being merged before the weekend is over. Can you have a look and give feedback? New docs are here: https://juliadynamics.github.io/Attractors.jl/previews/PR129/tutorial/

awage commented 1 week ago

Hello, timing is perfect. I have time to review the code this week.

Datseris commented 1 week ago

Thanks @awage I've addressed the raised comments inthe last push

Datseris commented 1 week ago

@KalelR it would be great if you can give some feedback here asap, I am hoping to use this tutorial in a presentation about attractors on Tuesday.

Datseris commented 1 week ago

As Juliacon is on one week and i wish to finish my talk now, since my talk is about Attractors.jl, I'll merge this in without waiting for Kalel. If Kalel has comments we can always improve later.