# Getting Started

The workflow for DataDrivenDiffEq.jl is similar to other SciML packages. You start by defining a `DataDrivenProblem`

and then dispatch on the `solve`

command to return a `DataDrivenSolution`

.

Here is an outline of the required elements and choices:

- Define a problem using your data.
- Data can be discrete, continuous, or direct.

- Choose a basis.
- This is optional depending on which solver you choose.

- Solve the problem.
- Many solvers exist; see the docs.

## Basic usage

```
using DataDrivenDiffEq, ModelingToolkit, LinearAlgebra
# The function we are trying to find
f(u) = u.^2 .+ 2.0u .- 1.0
#
X = randn(1, 100)
Y = reduce(hcat, map(f, eachcol(X)))
# Create a problem from the data
problem = DirectDataDrivenProblem(X, Y)
# Choose a basis
@variables u
basis = Basis(monomial_basis([u], 2), [u])
println(basis)
# Solve the problem, using the solver of your choosing
res = solve(problem, basis, STLSQ())
println(res)
println(result(res))
```

## Defining a Problem

Problems of identification, estimation, or inference are defined by data. These data contain at least measurements of the states `X`

, which would be sufficient to describe a `DiscreteDataDrivenProblem`

with unit time steps similar to the first example on dynamic mode decomposition. Of course, we can extend this to include time points `t`

, control signals `U`

or a function describing those `u(x,p,t)`

. Additionally, any parameters `p`

known a priori can be included in the problem. In practice, this looks like:

```
problem = DiscreteDataDrivenProblem(X)
problem = DiscreteDataDrivenProblem(X, t)
problem = DiscreteDataDrivenProblem(X, t, U)
problem = DiscreteDataDrivenProblem(X, t, U, p = p)
problem = DiscreteDataDrivenProblem(X, t, (x,p,t)->u(x,p,t))
```

Similarly, a `ContinuousDataDrivenProblem`

would need at least measurements and time-derivatives (`X`

and `DX`

) or measurements, time information and a way to derive the time derivatives(`X`

, `t`

and a Collocation method). Again, this can be extended by including a control input as measurements or a function and possible parameters:

```
problem = ContinuousDataDrivenProblem(X, DX)
problem = ContinuousDataDrivenProblem(X, t, DX)
problem = ContinuousDataDrivenProblem(X, t, DX, U, p = p)
problem = ContinuousDataDrivenProblem(X, t, DX, (x,p,t)->u(x,p,t))
# Using collocation
problem = ContinuousDataDrivenProblem(X, t, InterpolationMethod())
problem = ContinuousDataDrivenProblem(X, t, GaussianKernel())
problem = ContinuousDataDrivenProblem(X, t, U, InterpolationMethod())
problem = ContinuousDataDrivenProblem(X, t, U, GaussianKernel(), p = p)
```

You can also directly use a `DESolution`

as an input to your `DataDrivenProblem`

:

`problem = DataDrivenProblem(sol; kwargs...)`

which evaluates the function at the specific timepoints `t`

using the parameters `p`

of the original problem instead of using the interpolation. If you want to use the interpolated data, add the additional keyword `use_interpolation = true`

.

An additional type of problem is the `DirectDataDrivenProblem`

, which does not assume any kind of causal relationship. It is defined by `X`

and an observed output `Y`

in addition to the usual arguments:

```
problem = DirectDataDrivenProblem(X, Y)
problem = DirectDataDrivenProblem(X, t, Y)
problem = DirectDataDrivenProblem(X, t, Y, U)
problem = DirectDataDrivenProblem(X, t, Y, p = p)
problem = DirectDataDrivenProblem(X, t, Y, (x,p,t)->u(x,p,t), p = p)
```

## Choosing a Basis

A basis is optional, depending on the solver and solution method you are using. For instance, for DMD, a basis is not required, but for SINDy using STLQS(), it is required.

A basis can be defined like:

```
@variables u[1:2]
Ψ = Basis([u; u[1]^2], u)
```

See the Implicit Systems tutorials for more complex examples of defining a Basis.

## Solving the Problem

Next up, we choose a method to `solve`

the `DataDrivenProblem`

. Depending on the input arguments and the type of problem, the function will return a result derived via `Koopman`

, `Sparse Optimization`

, or general `Symbolic Regression`

. Different options can be provided, depending on the inference method, for options like rounding, normalization, or the progress bar. A `Basis`

can be used for lifting the measurements.

```
# Use a Koopman based inference
res = solve(problem, DMDSVD(), kwargs...)
# Use a sparse identification
res = solve(problem, basis, STLQS(), kwargs...)
```

The `DataDrivenSolution`

`res`

contains a `result`

which is the inferred system and a `Basis`

, `metrics`

which is a `NamedTuple`

containing different metrics of the inferred system. These can be accessed via:

```
# The inferred system
system = result(res)
# The metrics
m = metrics(res)
```

Since the inferred system is a parametrized equation, the corresponding parameters can be accessed and returned via

```
# Vector
ps = parameters(res)
# Parameter map
ps = parameter_map(res)
```

The keyword argument `eval_expression`

controls the function creation behavior. `eval_expression=true`

means that `eval`

is used, so normal world-age behavior applies (i.e. the functions cannot be called from the function that generates them). If `eval_expression=false`

, then construction via GeneralizedGenerated.jl is utilized to allow for same world-age evaluation. However, this can cause Julia to segfault on sufficiently large basis functions. By default eval_expression=false.