Installation

Requirements

The recommended way to install tscf-eval is via pip:

pip install tscf-eval

tscf-eval has several optional dependency groups:

DTW Support (for Dynamic Time Warping distance):

pip install tscf-eval[dtw]

Full Installation (all optional features):

pip install tscf-eval[full]

Development (testing, linting, etc.):

pip install tscf-eval[dev]

Documentation (Sphinx and plugins):

pip install tscf-eval[docs]

To install from source for development:

git clone https://github.com/bzamith/tscf-eval.git
cd tscf-eval
pip install -e ".[dev]"

You can verify the installation by importing the package:

import tscf_eval
print(tscf_eval.__version__)

Or by running the test suite:

pytest tests/ -v