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# Installation Instructions
21
22shapelets is available on all operating systems via Python's main package manager, pip. 
23Please ensure that Python 3.10+ is installed on your machine. If you do not have Python installed, see [here](#installing-python).
24
25If Python is installed on your machine, type `pip install shapelets` into your terminal/command line to install the shapelets package. 
26New users are also encouraged to visit the [official website](https://uw-comphys.github.io/shapelets/shapelets.html) to understand how the shapelets package can be used along with detailed examples, custom terminal commands provided by the package, and more. 
27
28## Installing Python
29
30### Windows
31
321. Download Python 3.10+ from the [official website](https://www.python.org/) or from the Microsoft Store
332. Open Command Prompt, and install the shapelets package via: `pip install shapelets`
343. Optionally, after successful installation, you can verify the integrity of the shapelets package via: `shapelets-test`
35
36### Mac OS
37
38Please ensure your macOS is at least macOS 12 Monterey (released 2021).
39
401. Install [Homebrew](https://brew.sh/) by copy and pasting the link on their homepage into your terminal
412. Install Python 3.10 and pip via: `brew install python@3.10` (automatically installs pip) 
423. Install the shapelets package via `pip install shapelets`
434. Optionally, after successful installation, you can verify the integrity of the shapelets package via: `shapelets-test`
44
45### Linux
46
471. For debian based distributions (i.e. Ubuntu), update your system via: `sudo apt-get update`
482. Install Python 3.10 and pip via: `sudo apt-get install python3.10 python3-pip`
493. Install the shapelets package via: `pip install shapelets`
504. Optionally, after successful installation, you can verify the integrity of the shapelets package via: `shapelets-test`
51
52"""