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# Custom Commands
21
22The shapelets package makes use of [entry points](https://packaging.python.org/en/latest/specifications/entry-points/).
23These are custom command-line arguments that trigger specific programming tasks in the background.
24
25* `shapelets CONFIG` - this entry point is used to interact with the shapelets package via configuration files. Here `CONFIG` is the name of the text-based configuration file that will perform a particular analysis based on its contents. See the package [examples](https://uw-comphys.github.io/shapelets/shapelets/docs.html) for useful demonstration. Note that the configuration file must be in the same directory as your working (terminal) directory to use this entry point correctly.
26* `shapelets-test` - triggers all [unit tests](https://github.com/uw-comphys/shapelets/tree/main/shapelets/tests) and will report any failures. It is encouraged to use this command if (1) you are modifying the package source code and (2) after initial [installation](https://uw-comphys.github.io/shapelets/shapelets/docs/installation_guide.html) of the shapelets package.
27
28"""