# 10. **[DocR]** Reference description of the ADAO commands and keywords¶

The following sections present the reference description of the ADAO commands and keywords available through the textual interface (TUI), the graphical interface (GUI) or through scripts. Two first common sections present the [DocR] General entries and outputs and the [DocR] Special entries: measurements, functions, matrices, “observer”, post-processing. After that, one describes successively the [DocR] Data assimilation or optimization calculation cases and the [DocR] Checking cases.

Each command or keyword to be defined through the ADAO TUI or GUI has some
properties. The first property is to be *required*, *optional* or only factual,
describing a type of input. The second property is to be an “open” variable
with a fixed type but with any value allowed by the type, or a “restricted”
variable, limited to some specified values. The embedded case editor GUI having
build-in validating capacities, the properties of the commands or keywords
given through this interface are automatically correct.

# 11. **[DocR]** General entries and outputs¶

This section describes in a very general way the different options of input types and output variables. The mathematical notations used are explained in section [DocT] A brief introduction to Data Assimilation and Optimization.

# 12. **[DocR]** Special entries: measurements, functions, matrices, “*observer*”, post-processing¶

This section describes special inputs, such as functional or matrix forms, and the requirements for using them. The mathematical concepts and notations related to these inputs are explained in section [DocT] A brief introduction to Data Assimilation and Optimization.

- 12.1. Requirements for observation or experimental measurements description
- 12.2. Requirements for functions describing an operator
- 12.3. Requirements to describe covariance matrices
- 12.4. Requirements for functions describing an “
*observer*” - 12.5. Requirements to describe a post-processing after an ADAO calculation

# 13. **[DocR]** Data assimilation or optimization calculation cases¶

This section describes algorithmic choices to use data assimilation methods, optimization methods or methods with reduction, available in ADAO, detailing their characteristics and their options.

Some examples on these commands usage are available in the section [DocU] Tutorials on using the ADAO module in SALOME, in the section [DocU] Tutorials on using the ADAO module in Python and in the sample files installed with ADAO. The mathematical concepts and notations used are explained in the section [DocT] A brief introduction to Data Assimilation and Optimization.

- 13.1. Calculation algorithm “
*3DVAR*” - 13.2. Calculation algorithm “
*4DVAR*” - 13.3. Calculation algorithm “
*Blue*” - 13.4. Calculation algorithm “
*DerivativeFreeOptimization*” - 13.5. Calculation algorithm “
*DifferentialEvolution*” - 13.6. Calculation algorithm “
*EnsembleBlue*” - 13.7. Calculation algorithm “
*EnsembleKalmanFilter*” - 13.8. Calculation algorithm “
*ExtendedBlue*” - 13.9. Calculation algorithm “
*ExtendedKalmanFilter*” - 13.10. Calculation algorithm “
*KalmanFilter*” - 13.11. Calculation algorithm “
*LinearLeastSquares*” - 13.12. Calculation algorithm “
*NonLinearLeastSquares*” - 13.13. Calculation algorithm “
*ParticleSwarmOptimization*” - 13.14. Calculation algorithm “
*QuantileRegression*” - 13.15. Calculation algorithm “
*TabuSearch*” - 13.16. Calculation algorithm “
*UnscentedKalmanFilter*” - 13.17. List of commands and keywords for data assimilation or optimisation case

# 14. **[DocR]** Checking cases¶

This section describes the checking algorithms available in ADAO, detailing their usage characteristics and their options.

Some examples on these commands usage are available in the section [DocU] Tutorials on using the ADAO module in SALOME, in the section [DocU] Tutorials on using the ADAO module in Python and in the sample files installed with ADAO. The mathematical concepts and notations used are explained in the section [DocT] A brief introduction to Data Assimilation and Optimization.

- 14.1. Checking algorithm “
*AdjointTest*” - 14.2. Checking algorithm “
*FunctionTest*” - 14.3. Checking algorithm “
*GradientTest*” - 14.4. Checking algorithm “
*InputValuesTest*” - 14.5. Checking algorithm “
*LinearityTest*” - 14.6. Checking algorithm “
*LocalSensitivityTest*” - 14.7. Checking algorithm “
*ObserverTest*” - 14.8. Checking algorithm “
*ParallelFunctionTest*” - 14.9. Checking algorithm “
*SamplingTest*” - 14.10. Checking algorithm “
*TangentTest*” - 14.11. List of commands and keywords for an ADAO checking case

# 15. **[DocR]** Dedicated tasks or study oriented cases¶

This section describes the dedicated task or study oriented cases available in ADAO, detailing their usage characteristics and their options.

These tasks use algorithms from data assimilation methods, optimization methods or methods with reduction. We refer to the [DocT] A brief introduction to Data Assimilation and Optimization section and the [DocR] Data assimilation or optimization calculation cases section for the underlying algorithmic details.