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# Package Interfacing
21
22The `shapelets` package can be interfaced in two different ways:
23
241. Configuration file method (developed for non-programmers)
25    * Parameters are described in a text-based configuration file, and the `shapelets` package then reads this file and runs the appropriate analysis
262. Scripting method (intended for those comfortable with Python programming)
27    * A more traditional format where relevant methods are imported in python files, i.e. 
28
29```python 
30from shapelets.functions import cartesian2D
31```
32
33The [examples](https://uw-comphys.github.io/shapelets/shapelets/docs.html) are implemented via the text-based configuration file method (#1 above).
34However, these examples also have associated Python files (.py) that perform the exact same analysis as shown via the configuration file method. 
35
36"""