Installation#

skbase currently supports:

  • environments with python version 3.7, 3.8, 3.9 or 3.10

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

Checkout the full list of pre-compiled wheels on PyPI.

Release versions#

Most users will be interested in installing a released version of skbase using one of the approaches outlined below. For common installation issues, see the Release versions - troubleshooting section.

Installing skbase from PyPI#

skbase releases are available via PyPI and can be installed via pip using:

pip install skbase

This will install skbase with core dependencies, excluding soft dependencies.

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

pip install skbase[all_extras]

Installing skbase from conda#

Note

We are still working on creating releases of skbase on conda. If you would like to help, please open a pull request.

Release versions - troubleshooting#

Missing soft fependencies#

Users may run into problems, when they install the core version of skbase, but attempt to use functionality that requires soft dependencies to be installed. To resolve this, install the missing package, or install skbase with maximum dependencies (see above).

Development versions#

To install the latest development version of skbase, the sequence of steps is as follows:

  1. Clone the skbase Github repository

  2. Use pip to build skbase from source

Detail instructions for each step is provided below.

Step 1 - Clone Github repository#

The skbase Github repository should be cloned to a local directory.

To install the latest version using the git command line, use the following steps:

  1. Use your command line tool to navigate to the directory where you want to clone skbase

  2. Clone the repository: git clone https://github.com/sktime/baseobject.git

  3. Move into the root directory of the package’s local clone: cd baseobject

  4. Make sure you are on the main branch: git checkout main

  5. Make sure your local version is up-to-date: git pull

See Github’s documentation for additional details.

Hint

If you want to checkout an earlier version of skbase you can use the following git command line after cloning to run: git checkout <VERSION>

Where <VERSION> is a valid version string that can be found by inspecting the repository’s git tags, by running git tag.

You can also download a specific release version from the Github repository’s zip archive of releases.

Step 2 - Build skbase from source#

For a static install of skbase from source, navigate to your local clone’s root directory run the following in your command line:

pip install .

Hint

In either the static or editable installation, the . may be replaced with a full or relative path to your local clone’s root directory.

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

pip install --editable .[dev]

Including “[dev]” also makes sure that the optional dev dependencies specified in the skbase’s pypyroject.toml file are also installed.

Hint

By including “[dev]” above, pre-commit and other tools you’ll want to use when developing skbase are also installed. In most cases, you’ll let pre-commit manage installation environments for your linting tools. However, some integrated development environments (for example, VS Code) will automatically apply linters (including reformatting) on save. If you want to easily Install all the linters in your environment use pip install --editable .[dev,linters].

Building binary packages and installers#

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

pip install wheel
python setup.py bdist_wheel

The resulting packages are generated in the dist/ folder.

References#

The installation instruction are adapted from sktime’s installation instructions.