Merge pull request #1 from neveritt/master

Initial version of package

LICENSE.md

@@ -1,23 +1,186 @@
-The IdentificationToolbox.jl package is licensed under the MIT "Expat" License:
+The IdentificationToolbox.jl package is licensed under the Lesser GNU Public License,
+Version 3.0+:
 
-> Copyright (c) 2016: Arda Aytekin ([aytekin@kth.se](mailto:aytekin@kth.se)),
-> Niklas Everitt ([neveritt@kth.se](mailto:neveritt@kth.se)).
->
-> Permission is hereby granted, free of charge, to any person obtaining
-> a copy of this software and associated documentation files (the
-> "Software"), to deal in the Software without restriction, including
-> without limitation the rights to use, copy, modify, merge, publish,
-> distribute, sublicense, and/or sell copies of the Software, and to
-> permit persons to whom the Software is furnished to do so, subject to
-> the following conditions:
->
-> The above copyright notice and this permission notice shall be
-> included in all copies or substantial portions of the Software.
->
-> THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
-> EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF
-> MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.
-> IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY
-> CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT,
-> TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE
-> SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
+> Copyright (c) 2016: Niklas Everitt (neveritt@kth.se).
+> This library is free software; you can redistribute it and/or
+> modify it under the terms of the GNU Lesser General Public
+> License as published by the Free Software Foundation; either
+> version 3 of the License, or (at your option) any later version.
+>
+> This library is distributed in the hope that it will be useful,
+> but WITHOUT ANY WARRANTY; without even the implied warranty of
+> MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+> Lesser General Public License for more details.
+>
+> You should have received a copy of the GNU Lesser General Public
+> License along with this library; if not, write to the Free Software
+> Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA  02110-1301  USA
+>
+>                    GNU LESSER GENERAL PUBLIC LICENSE
+>                        Version 3, 29 June 2007
+>
+>  Copyright (C) 2007 Free Software Foundation, Inc. <http://fsf.org/>
+>  Everyone is permitted to copy and distribute verbatim copies
+>  of this license document, but changing it is not allowed.
+>
+>
+>   This version of the GNU Lesser General Public License incorporates
+> the terms and conditions of version 3 of the GNU General Public
+> License, supplemented by the additional permissions listed below.
+>
+>   0. Additional Definitions.
+>
+>   As used herein, "this License" refers to version 3 of the GNU Lesser
+> General Public License, and the "GNU GPL" refers to version 3 of the GNU
+> General Public License.
+>
+>   "The Library" refers to a covered work governed by this License,
+> other than an Application or a Combined Work as defined below.
+>
+>   An "Application" is any work that makes use of an interface provided
+> by the Library, but which is not otherwise based on the Library.
+> Defining a subclass of a class defined by the Library is deemed a mode
+> of using an interface provided by the Library.
+>
+>   A "Combined Work" is a work produced by combining or linking an
+> Application with the Library.  The particular version of the Library
+> with which the Combined Work was made is also called the "Linked
+> Version".
+>
+>   The "Minimal Corresponding Source" for a Combined Work means the
+> Corresponding Source for the Combined Work, excluding any source code
+> for portions of the Combined Work that, considered in isolation, are
+> based on the Application, and not on the Linked Version.
+>
+>   The "Corresponding Application Code" for a Combined Work means the
+> object code and/or source code for the Application, including any data
+> and utility programs needed for reproducing the Combined Work from the
+> Application, but excluding the System Libraries of the Combined Work.
+>
+>   1. Exception to Section 3 of the GNU GPL.
+>
+>   You may convey a covered work under sections 3 and 4 of this License
+> without being bound by section 3 of the GNU GPL.
+>
+>   2. Conveying Modified Versions.
+>
+>   If you modify a copy of the Library, and, in your modifications, a
+> facility refers to a function or data to be supplied by an Application
+> that uses the facility (other than as an argument passed when the
+> facility is invoked), then you may convey a copy of the modified
+> version:
+>
+>    a) under this License, provided that you make a good faith effort to
+>    ensure that, in the event an Application does not supply the
+>    function or data, the facility still operates, and performs
+>    whatever part of its purpose remains meaningful, or
+>
+>    b) under the GNU GPL, with none of the additional permissions of
+>    this License applicable to that copy.
+>
+>   3. Object Code Incorporating Material from Library Header Files.
+>
+>   The object code form of an Application may incorporate material from
+> a header file that is part of the Library.  You may convey such object
+> code under terms of your choice, provided that, if the incorporated
+> material is not limited to numerical parameters, data structure
+> layouts and accessors, or small macros, inline functions and templates
+> (ten or fewer lines in length), you do both of the following:
+>
+>    a) Give prominent notice with each copy of the object code that the
+>    Library is used in it and that the Library and its use are
+>    covered by this License.
+>
+>    b) Accompany the object code with a copy of the GNU GPL and this license
+>    document.
+>
+>   4. Combined Works.
+>
+>   You may convey a Combined Work under terms of your choice that,
+> taken together, effectively do not restrict modification of the
+> portions of the Library contained in the Combined Work and reverse
+> engineering for debugging such modifications, if you also do each of
+> the following:
+>
+>    a) Give prominent notice with each copy of the Combined Work that
+>    the Library is used in it and that the Library and its use are
+>    covered by this License.
+>
+>    b) Accompany the Combined Work with a copy of the GNU GPL and this license
+>    document.
+>
+>    c) For a Combined Work that displays copyright notices during
+>    execution, include the copyright notice for the Library among
+>    these notices, as well as a reference directing the user to the
+>    copies of the GNU GPL and this license document.
+>
+>    d) Do one of the following:
+>
+>        0) Convey the Minimal Corresponding Source under the terms of this
+>        License, and the Corresponding Application Code in a form
+>        suitable for, and under terms that permit, the user to
+>        recombine or relink the Application with a modified version of
+>        the Linked Version to produce a modified Combined Work, in the
+>        manner specified by section 6 of the GNU GPL for conveying
+>        Corresponding Source.
+>
+>        1) Use a suitable shared library mechanism for linking with the
+>        Library.  A suitable mechanism is one that (a) uses at run time
+>        a copy of the Library already present on the user's computer
+>        system, and (b) will operate properly with a modified version
+>        of the Library that is interface-compatible with the Linked
+>        Version.
+>
+>    e) Provide Installation Information, but only if you would otherwise
+>    be required to provide such information under section 6 of the
+>    GNU GPL, and only to the extent that such information is
+>    necessary to install and execute a modified version of the
+>    Combined Work produced by recombining or relinking the
+>    Application with a modified version of the Linked Version. (If
+>    you use option 4d0, the Installation Information must accompany
+>    the Minimal Corresponding Source and Corresponding Application
+>    Code. If you use option 4d1, you must provide the Installation
+>    Information in the manner specified by section 6 of the GNU GPL
+>    for conveying Corresponding Source.)
+>
+>   5. Combined Libraries.
+>
+>   You may place library facilities that are a work based on the
+> Library side by side in a single library together with other library
+> facilities that are not Applications and are not covered by this
+> License, and convey such a combined library under terms of your
+> choice, if you do both of the following:
+>
+>    a) Accompany the combined library with a copy of the same work based
+>    on the Library, uncombined with any other library facilities,
+>    conveyed under the terms of this License.
+>
+>    b) Give prominent notice with the combined library that part of it
+>    is a work based on the Library, and explaining where to find the
+>    accompanying uncombined form of the same work.
+>
+>   6. Revised Versions of the GNU Lesser General Public License.
+>
+>   The Free Software Foundation may publish revised and/or new versions
+> of the GNU Lesser General Public License from time to time. Such new
+> versions will be similar in spirit to the present version, but may
+> differ in detail to address new problems or concerns.
+>
+>   Each version is given a distinguishing version number. If the
+> Library as you received it specifies that a certain numbered version
+> of the GNU Lesser General Public License "or any later version"
+> applies to it, you have the option of following the terms and
+> conditions either of that published version or of any later version
+> published by the Free Software Foundation. If the Library as you
+> received it does not specify a version number of the GNU Lesser
+> General Public License, you may choose any version of the GNU Lesser
+> General Public License ever published by the Free Software Foundation.
+>
+>   If the Library as you received it specifies that a proxy can decide
+> whether future versions of the GNU Lesser General Public License shall
+> apply, that proxy's public statement of acceptance of any version is
+> permanent authorization for you to choose that version for the
+> Library.
+>
+>                     END OF TERMS AND CONDITIONS
+>

README.md

@@ -1,3 +1,28 @@
 # IdentificationToolbox
 
-[![Build Status](https://travis-ci.org/KTH-AC/IdentificationToolbox.jl.svg?branch=master)](https://travis-ci.org/KTH-AC/IdentificationToolbox.jl)
+System identification toolbox for Julia.
+
+### Build Status and Code Coverage
+
+-  Build status: [![Build Status][build-img]][build-link]
+-  Code coverage: [![Coveralls][ca-img]][ca-link] [![Codecov][cc-img]][cc-link]
+
+[build-img]:  https://travis-ci.org/KTH-AC/IdentificationToolbox.jl.jl.svg?branch=master
+[build-link]: https://travis-ci.org/KTH-AC/IdentificationToolbox.jl.jl
+[ca-img]: https://coveralls.io/repos/github/KTH-AC/IdentificationToolbox.jl.jl/badge.svg?branch=master
+[ca-link]: https://coveralls.io/github/KTH-AC/IdentificationToolbox.jl.jl?branch=master
+[cc-img]: https://codecov.io/gh/KTH-AC/IdentificationToolbox.jl.jl/branch/master/graph/badge.svg
+[cc-link]: https://codecov.io/gh/KTH-AC/IdentificationToolbox.jl.jl
+
+### Description
+
+This package is meant to provided methods for constructing mathematical models
+of dynamic systems based on input-output data.
+
+```julia
+using IdentificationToolbox
+u = randn(1000)
+y = filt([0,1],[1,0.7],u) + randn(1000)
+data = iddata(y,u,1)
+model = pem(data, [2,2,1], ARX())
+```

REQUIRE

@@ -1 +1,7 @@
 julia 0.4
+Polynomials 0.1.0
+Optim 0.6.0
+ControlCore 0.0.1
+Compat 0.9.0
+ToeplitzMatrices 0.1.1
+GeneralizedSchurAlgorithm 0.0.2

src/.travis.yml

@@ -0,0 +1,23 @@
+language: julia
+
+julia:
+  - 0.4
+  - 0.5
+  - nightly
+
+matrix:
+  fast_finish: true
+  allow_failures:
+    - julia: nightly
+
+notifications:
+  email: false
+
+script:
+  - julia -e 'Pkg.clone(pwd())'
+  - julia --check-bounds=yes --inline=no -e 'Pkg.test("IdentificationToolbox",
+    coverage=true)'
+
+after_success:
+  - julia -e 'cd(Pkg.dir("IdentificationToolbox")); Pkg.add("Coverage"); using Coverage;
+    Coveralls.submit(process_folder()); Codecov.submit(process_folder())'

src/IdentificationToolbox.jl

@@ -1,5 +1,60 @@
 module IdentificationToolbox
 
-# package code goes here
+import Base.==
+
+# Import printing functions
+import Base: showcompact, show, showall, summary
+
+export
+  # datatypes
+  IdDataObject,
+  IdDSs,
+  IdDSisoRational,
+  iddata,
+  # utilities
+  detrend,
+  detrend!,
+  dare,
+  compare,
+  filtic,
+  # identification methods
+  fir,    FIR,
+  arx,    ARX,
+  armax,  ARMAX,
+  oe,     OE,
+  bj,     BJ,
+  n4sid,
+  stmcb,  STMCB,
+  morsm,  MORSM,
+  pem,
+  # method functions
+  predict,
+  fitmodel
+
+using Polynomials, Optim, ControlCore, ToeplitzMatrices,
+  GeneralizedSchurAlgorithm, Compat
+
+# types
+include("types/iddata.jl")
+include("types/idmethods.jl")
+include("types/idinfo.jl")
+include("types/iddsisorational.jl")
+include("types/iddss.jl")
+
+# utilities
+include("utilities/filtic.jl")
+include("utilities/detrend.jl")
+include("utilities/compare.jl")
+
+# methods
+include("methods/pem.jl")
+include("methods/armax.jl")
+include("methods/bj.jl")
+include("methods/oe.jl")
+include("methods/arx.jl")
+include("methods/fir.jl")
+include("methods/stmcb.jl")
+include("methods/morsm.jl")
+include("methods/n4sid.jl")
 
 end # module