fix docs (#118)

* fix docs * correct projecttoml
JuliaDynamics · Feb 17, 2023 · dc36254 · dc36254
1 parent c6741dd
commit dc36254
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 22 deletions.
diff --git a/docs/Project.toml b/docs/Project.toml
@@ -1,18 +1,8 @@
 [deps]
 CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
-ChaosTools = "608a59af-f2a3-5ad4-90b4-758bdf3122a7"
-ComplexityMeasures = "ab4b797d-85ee-42ba-b621-05d793b346a2"
-CoordinateTransformations = "150eb455-5306-5404-9cee-2592286d6298"
-DelayEmbeddings = "5732040d-69e3-5649-938a-b6b4f237613f"
-Distributions = "31c24e10-a181-5473-b8eb-7969acd0382f"
 Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
 DocumenterTools = "35a29f4d-8980-5a13-9543-d66fff28ecb8"
 DynamicalSystemsBase = "6e36e845-645a-534a-86f2-f5d4aa5a06b4"
-ImageTransformations = "02fcd773-0e25-5acc-982a-7f6622650795"
-Rotations = "6038ab10-8711-5258-84ad-4b1120ba62dc"
-SpecialFunctions = "276daf66-3868-5448-9aa4-cd146d93841b"
-StateSpaceSets = "40b095a5-5852-4c12-98c7-d43bf788e795"
-StaticArrays = "90137ffa-7385-5640-81b9-e52037218182"
-Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
-TestImages = "5e47fb64-e119-507b-a336-dd2b206d9990"
-TimeseriesSurrogates = "c804724b-8c18-5caa-8579-6025a0767c70"
+
+[compat]
+DynamicalSystemsBase = "3"
diff --git a/docs/src/embed.md b/docs/src/embed.md
@@ -1,4 +1,4 @@
-# Delay coordinates embedding
+# [Delay coordinates embedding](@id embedding)
 
 A timeseries recorded in some manner from a dynamical system can be used to gain information about the dynamics of the entire state space of the system. This can be done by constructing a new state space from the timeseries. One method that can do this is what is known as [delay coordinates embedding](https://en.wikipedia.org/wiki/Takens%27_theorem) or delay coordinates reconstruction.
 

diff --git a/docs/src/index.md b/docs/src/index.md
@@ -10,4 +10,12 @@ DelayEmbeddings
     The documentation and the code of this package is parallelizing Chapter 6 of [Nonlinear Dynamics](https://link.springer.com/book/10.1007/978-3-030-91032-7), Datseris & Parlitz, Springer 2022.
 
 
-See page x for X and y for Y.
+The package provides an interface to perform delay coordinates embeddings, as explained in [homonymous page](@ref embedding).
+
+There are two approaches for estimating optimal parameters to do delay embeddings:
+1. **Separated**, where one tries to find the best value for a delay time `τ` and then an optimal embedding dimension `d`.
+2. **Unified**, where at the same time an optimal combination of `τ, d` is found.
+
+The separated approach is something "old school", while recent scientific research has shifted almost exclusively to unified approaches. This page describes algorithms belonging to the separated approach, which is mainly done by the function [`optimal_traditional_de`](@ref).
+
+The unified approach is discussed in the [Unified optimal embedding](@ref) page.
diff --git a/docs/src/separated.md b/docs/src/separated.md
@@ -1,11 +1,5 @@
 # Separated optimal embedding
-This page discusses and provides algorithms for estimating optimal parameters to do Delay Coordinates Embedding (DCE) with.
-
-There are two approaches for estimating optimal parameters to do delay embeddings:
-1. **Separated**, where one tries to find the best value for a delay time `τ` and then an optimal embedding dimension `d`.
-2. **Unified**, where at the same time an optimal combination of `τ, d` is found, and is discussed in the [Unified optimal embedding](@ref) page.
-
-The separated approach is something "old school", while recent scientific research has shifted almost exclusively to unified approaches. This page describes algorithms belonging to the separated approach, which is mainly done by the function [`optimal_traditional_de`](@ref).
+This page discusses and provides algorithms for estimating optimal parameters to do Delay Coordinates Embedding (DCE) with using the separated approach.
 
 ## Optimal delay time
 ```@docs