00001 """
00002 user interface to the slimpy core
00003 @package slimpy_base.api
00004
00005 The api package contains:
00006 - functions
00007 - linear operators
00008 - plugin definitions
00009
00010 @defgroup userclasses classes for users
00011 These classes are a collecion of types that a end user may use in a SLIMpy project
00012
00013 @defgroup functions user functions
00014 Functions in this group are generaly related to slimpy_base.Core.User.Structures.serial_vector.Vector and
00015 slimpy_base.Core.User.Structures.Scalar.Scalar objects
00016
00017 @defgroup linop linear operators
00018 Contains a list of linear operators defined in SLIMpy
00019
00020 """
00021 __copyright__ = """
00022 Copyright 2008 Sean Ross-Ross
00023 """
00024 __license__ = """
00025 This file is part of slimpy_base.
00026
00027 SLIMpy is free software: you can redistribute it and/or modify
00028 it under the terms of the GNU Lesser General Public License as published by
00029 the Free Software Foundation, either version 3 of the License, or
00030 (at your option) any later version.
00031
00032 SLIMpy is distributed in the hope that it will be useful,
00033 but WITHOUT ANY WARRANTY; without even the implied warranty of
00034 MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
00035 GNU Lesser General Public License for more details.
00036
00037 You should have received a copy of the GNU Lesser General Public License
00038 along with SLIMpy . If not, see <http://www.gnu.org/licenses/>.
00039 """
00040
00041
