shapelets.docs

 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## Documentation 
21
22This submodule contains documentation for the shapelets package. You can navigate the documentation on the left-hand side, and below is an overview of each tab. 
23
24### Changelog
25
26The changelog for the shapelets package, providing an overview of changes associated to each version release.
27
28### Commmands
29
30This page describes the custom commands created for the shapelets package to be used from the command-line.
31
32### Examples
33
34We provide a series of examples demonstrating the shapelets applications included with shapelets. 
35
36Examples for the **shapelets.self_assembly** submodule:
37* Example 1 - the response distance method ([R. Suderman (2015)](https://doi.org/10.1103/PhysRevE.91.033307))
38* Example 2 - the defect identification method ([M.P. Tino (2024)](http://dx.doi.org/10.1088/1361-6528/ad1df4))
39* Example 3 - local pattern orientation method ([M.P. Tino (2024)](http://dx.doi.org/10.1088/1361-6528/ad1df4))
40
41Examples for the **shapelets.astronomy** submodule:
42* Example 4 - decomposition and reconstruction of images of galaxies ([A. Refregier (2003)](https://doi.org/10.1046/j.1365-8711.2003.05901.x))
43
44### Install
45
46The installation guide for the shapelets package for Windows, macOS, and Linux (Ubuntu). 
47
48"""
49
50from .changelog import *
51from .commands import *
52from .example_1 import *
53from .example_2 import *
54from .example_3 import *
55from .example_4 import *
56from .install import *