Installation#

aeon currently supports:

  • Python versions 3.8, 3.9 and 3.10.

  • Operating systems Mac OS X, Unix-like OS, Windows 8.1 and higher

See here for a full list of precompiled wheels available on PyPI.

We appreciate community contributions towards compatibility with python 3.10, or other operating systems.

Release versions#

For frequent issues with installation, consult the `Release versions - troubleshooting`_ section.

Installing aeon from PyPI#

aeon releases are available via PyPI. To install aeon with core dependencies, excluding soft dependencies, via pip type:

pip install aeon

To install aeon with maximum dependencies, including soft dependencies, install with the all_extras modifier:

pip install aeon[all_extras]

Warning

Some of the dependencies included in all_extras do not work on mac ARM-based processors, such as M1, M2, M1Pro, M1Max or M1Ultra. This may cause an error during installation. Mode details can be found in the troubleshooting section below.

Installing aeon from conda#

aeon releases are available via conda from conda-forge. To install aeon with core dependencies, excluding soft dependencies via conda type:

conda install -c conda-forge aeon

To install aeon with maximum dependencies, including soft dependencies, install with the all-extras recipe:

conda install -c conda-forge aeon-all-extras

Note: currently this does not include the dependency catch-22. As this package is not available on conda-forge, it must be installed via pip if desired. Contributions to remedy this situation are appreciated.

Development versions#

To install the latest development version of aeon, or earlier versions, the sequence of steps is as follows:

Step 1 - git clone the aeon repository, the latest version or an earlier version. Step 2 - ensure build requirements are satisfied Step 3 - pip install the package from a git clone, with the editable parameter.

Detail instructions for all steps are given below. For brevity, we discuss steps 1 and 3 first; step 2 is discussed at the end, as it will depend on the operating system.

Step 1 - clone the git repository#

The aeon repository should be cloned to a local directory, using a graphical user interface, or the command line.

Using the git command line, the sequence of commands to install the latest version is as follows:

git clone https://github.com/aeon-toolkit/aeon.git
cd aeon
git checkout main
git pull

To build a previous version, replace line 3 with:

git checkout <VERSION>

This will checkout the code for the version <VERSION>, where <VERSION> is a valid version string. Valid version strings are the repository’s git tags, which can be inspected by running git tag.

You can also download a zip archive of the version from GitHub.

Step 2 - satisfying build requirements#

Before carrying out step 3, the aeon build requirements need to be satisfied. Details for this differ by operating system, and can be found in the aeon build requirements section below.

Typically, the set-up steps needs to be carried out only once per system.

Step 3 - building aeon from source#

To build and install aeon from source, navigate to the local clone’s root directory and type:

pip install .

Alternatively, the . may be replaced with a full or relative path to the root directory.

For a developer install that updates the package each time the local source code is changed, install aeon in editable mode, via:

pip install --editable .[dev]

This allows editing and extending the code in-place. See also pip reference on editable installs).

Note

You will have to re-run:

pip install --editable .

every time the source code of a compiled extension is changed (for instance when switching branches or pulling changes from upstream).

Building binary packages and installers#

The .whl package and .exe installers can be built with:

pip install build
python -m build --wheel

The resulting packages are generated in the dist/ folder.

aeon build requirements#

This section outlines the aeon build requirements. These are required for:

  • installing aeon from source, e.g., development versions

  • the advanced developer set-up

Setting up a development environment#

First set up a new virtual environment. Our instructions will go through the commands to set up a conda environment which is recommended for aeon development. This relies on an anaconda installation. The process will be similar for venv or other virtual environment managers.

In the anaconda prompt terminal:

  1. Navigate to your local aeon folder cd aeon

  2. Create new environment with python 3.8: conda create -n aeon-dev python=3.8

    Warning

    If you already have an environment called “aeon-dev” from a previous attempt you will first need to remove this.

  3. Activate the environment: conda activate aeon-dev

  4. Build an editable version of aeon pip install -e .[all_extras,dev]

  5. If everything has worked you should see message “successfully installed aeon”

Some users have experienced issues when installing NumPy, particularly version 1.19.4.

Note

If step 4. results in a “no matches found” error, it may be due to how your shell handles special characters.

  • Possible solution: use quotation marks:

    pip install -e ."[all_extras,dev]"

Note

Another option under Windows is to follow the instructions for `Unix-like OS`_, using the Windows Subsystem for Linux (WSL). For installing WSL, follow the instructions here.

Troubleshooting#

Module not found#

The most frequent reason for module not found errors is installing aeon with minimum dependencies and using an estimator which interfaces a package that has not been installed in the environment. To resolve this, install the missing package, or install aeon with maximum dependencies (see above).

ImportError#

Import errors are often caused by an improperly linked virtual environment. Make sure that your environment is activated and linked to whatever IDE you are using. If you are using Jupyter Notebooks, follow these instructions for adding your virtual environment as a new kernel for your notebook.

Installing all_extras on mac with ARM processor#

If you are using a mac with an ARM processor, you may encounter an error when installing aeon[all_extras]. This is due to the fact that some libraries included in all_extras are not compatible with ARM-based processors.

The workaround is not to install some of the packages in all_extras and install ARM compatible replacements for others:

  • Do not install the following packages:

    • esig

    • prophet

    • tsfresh

    • tslearn

  • Replace tensorflow package with the following packages:

    • tensorflow-macos

    • tensorflow-metal (optional)

Also, ARM-based processors have issues when installing packages distributed as source distributions instead of Python wheels. To avoid this issue when installing a package you can try installing it through conda or use a prior version of the package that was distributed as a wheel.

Other Startup Resources#

Virtual environments#

Two good options for virtual environment managers are:

  • conda (many aeon community members us this)

  • venv (also quite good!).

Be sure to link your new virtual environment as the python kernel in whatever IDE you are using. You can find the instructions for doing so in VScode here.

References#

The installation instruction are adapted from scikit-learn’s advanced installation instructions.