Documentation

Welcome to the osl-dynamics documentation!

The API reference provides documentation for the classes, methods and functions in osl-dynamics. New users may find the FAQ useful.

New users are encouraged to have a look at the config API interface: here.

Models

Various models are implemented in osl-dynamics. Finalised models that have been used in published papers are described below.

• Hidden Markov Model (HMM).

• Dynamic Network Modes (DyNeMo).

Tutorials

The following tutorials illustrate basic usage and analysis that can be done with osl-dynamics.

Data tutorials:

• Loading Data.

• Preparing Data.

Static modelling tutorials:

• Static: Spectral Analysis.

• Static: Power Analysis.

• Static: Amplitude Envelope Correlation (AEC) Analysis.

Dynamic modelling tutorials:

• Sliding Window Analysis.

• HMM: Simulation.

• HMM: Training on Real Data.

• HMM: Summary Statistic Analysis.

• HMM: Power Analysis.

• HMM: Coherence Analysis.

• HMM: Evoked Response Analysis.

• DyNeMo: Minimal Code.

• DyNeMo: Soft Mixture Simulation.

• DyNeMo: Long-Range Dependencies Simulation.

• DyNeMo: Training on Real Data.

• DyNeMo: Mixing Coefficients Analysis.

• DyNeMo: Plotting Networks.

More examples scripts can be found in the examples directory of the repo.

Workshops

• 2023 OHBA Software Library (OSL) workshop.