Installation

From PyPi

The preferred way to install dtaianomaly is through PyPI. Use the following command to install the latest version:

pip install dtaianomaly

Some dependencies are optional to ensure that dtaianomaly remains lightweight. Use the following command to install all optional dependencies:

pip install dtaianomaly[all]

It is also possible to only install a subset of the optional dependencies. You can install these by replacing ‘all’ with the corresponding name in the command above. To install multiple subsets, separate the names with a comma. Currently, following subsets are available:

  • tests: Dependencies for running the tests.

  • tqdm: Install TQDM (for showing WorkFlow-progress)

  • docs: Dependencies for generating the documentation.

  • notebooks: Dependencies for using jupyter notebooks.

  • lint: Dependencies for linting the code.

  • chronos: Install autogluon.timeseries, necessary for running Chronos. Warning: Not included when installing dtaianomaly[all]!

  • moment: Install momentfm, necessary for running MOMENT. Warning: Not included when installing dtaianomaly[all]!

  • time_moe: Install transformers==4.40.1, necessary for running Time-MoE. Warning: Not included when installing dtaianomaly[all]!

To install version X.Y.Z, use the following command:

pip install dtaianomaly==X.Y.Z

From GitHub

It is also possible to install dtaianomaly directly from GitHub:

pip install git+https://github.com/ML-KULeuven/dtaianomaly

Note that this will install the latest, unreleased version. Similarly as installation through PyPi, it is also possible to install version X.Y.Z as follows:

pip install git+https://github.com/ML-KULeuven/dtaianomaly@X.Y.Z

See the release page for more information regarding the different versions.

From source

Finally, it is also possible to install dtaianomaly from the source code. First download the source from GitHub. It is also possible to download the source code for a specific release on this webpage. Unzip the files, and navigate to the root directory of the repository in the terminal. Then, dtaianomaly can be installed through the following command:

pip install .