shapelets.docs.commands
Custom Commands
The shapelets library makes use of entry points. Entry points are custom command-line arguments to use the shapelets package.
shapelets-run /path/to/config
- To run shapelets analysis via configuration files
- Here
/path/to/config
is the relative or absolute filepath to your configuration file - see the examples
shapelets-test
- Triggers all shapelets unit tests.
- You should use this command after modifying the source code or to confirm successful installation of the shapelets package
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/commands.md 21 22"""