shapelets.docs.install

Installation Guide

The shapelets python package is available on Windows, macOS, and most Linux distributions. See below for OS-specific installation instructions.

Windows

  1. Download Python 3.10 from the official website or from the Microsoft Store
  2. Open Command Prompt, and install the shapelets library via: pip install shapelets
  3. Optionally, after successful installation, you can verify the integrity of the shapelets library via: shapelets-test

macOS

Please ensure your macOS is at least macOS 12 Monterey (released 2021).

  1. Install Homebrew by copy and pasting the link on their homepage into your terminal
  2. Install Python 3.10 and pip via: brew install python@3.10 (automatically installs pip)
  3. Install the shapelets library via pip3.10 install shapelets
  4. Optionally, after successful installation, you can verify the integrity of the shapelets library via: shapelets-test

Linux

  1. For debian based distributions (i.e. Ubuntu), update your system via: sudo apt-get update
  2. Install Python 3.10 and pip via: sudo apt-get install python3.10 python3-pip
  3. Install the shapelets library via: pip install shapelets
  4. Optionally, after successful installation, you can verify the integrity of the shapelets library via: shapelets-test
 1########################################################################################################################
 2# Copyright 2023 the authors (see AUTHORS file for full list).                                                         #
 3#                                                                                                                      #
 4# This file is part of shapelets.                                                                                      #
 5#                                                                                                                      #
 6# Shapelets is free software: you can redistribute it and/or modify it under the terms of the GNU Lesser General       #
 7# Public License as published by the Free Software Foundation, either version 2.1 of the License, or (at your option)  #
 8# any later version.                                                                                                   #
 9#                                                                                                                      #
10# Shapelets is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied      #
11# warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more  #
12# details.                                                                                                             #
13#                                                                                                                      #
14# You should have received a copy of the GNU Lesser General Public License along with shapelets. If not, see           #
15# <https://www.gnu.org/licenses/>.                                                                                     #
16########################################################################################################################
17
18r"""
19
20.. include:: ../../docs/install.md
21
22"""