search

gaioguys / GAIO.jl

A Julia package for set oriented computations.
MIT License
8 stars 4 forks source link

Big docs update #95

Closed April-Hannah-Lena closed 1 year ago

April-Hannah-Lena commented 1 year ago

The docs just got a huge upgrade. Each BoxMap discretization as well as each algorithm has a page in the docs with mathematical background and a concrete example. All examples are also run during the build phase for the docs site, meaning that the docs are always up to date. In particular: if in a future PR something breaking changes, then the changes would break the docs page as well, making the break very easy to find and fix.

I found a way to host the docs in this PR on April-Hannah-Lena.github.io/GAIO.jl/. All the docs files which generated the site are in /docs/src/ folder. To build the docs locally, e.g. after making some changes, one can run

julia> cd("path/to/GAIO.jl/docs/src")

pkg> activate ..

pkg> dev ../..

pkg> instantiate

julia> include("../make.jl")
gaioguy commented 1 year ago

Awesome! Can we reorganize the chapter on the algorithms a little? My suggestion:

  1. Invariant sets a. Maximal invariant set b. Chain recurrent sets b. Attractors b. Stable and unstable sets/manifolds
  2. Transfer and Koopman operators a. Ulam's method and invariant measures b. Almost invariant (metastable) sets c. Cyclic sets d. Coherent sets e. Extracting multiple almost invariant/coherent sets via SEBA
  3. Scalar diagnostics a. Lyapunov exponents/FTLEs b. Box dimension c. Entropy
  4. Misceallenous a. Root finding/global optimization b. Implicitely defined manifolds

... and then later, we add the stuff on multiobjective optimization, global optimal control and Conley index step by step.

April-Hannah-Lena commented 1 year ago

Ok, I've rearranged the docs pages and resolved the conversations from above. The section on coherent sets doesn't work properly yet. I'm not sure why, working on that. The page should still appear though, maybe you can look at it?

The docs are being built right now (as of 9:00), which usually takes ~30min.

gaioguy commented 1 year ago

Great, that is a big improvement. I will have a detailed look at the coherent sets page.