Skip to content
Snippets Groups Projects
Commit 688c1a5d authored by Denis Arrivault's avatar Denis Arrivault
Browse files

Correct some errors in the documentation

parent 989eb9ed
No related branches found
No related tags found
No related merge requests found
Pipeline #
...@@ -9,7 +9,7 @@ The package provides a large number of linear transforms including Gabor ...@@ -9,7 +9,7 @@ The package provides a large number of linear transforms including Gabor
transforms along with routines for constructing windows (filter prototypes) transforms along with routines for constructing windows (filter prototypes)
and routines for manipulating coefficients. and routines for manipulating coefficients.
The orginal LTFAT Toolbox for MATLAB®/Octave is developed at The original LTFAT Toolbox for MATLAB®/Octave is developed at
`CAHR <http://www.dtu.dk/centre/cahr/English.aspx>`_, Technical `CAHR <http://www.dtu.dk/centre/cahr/English.aspx>`_, Technical
University of Denmark, `ARI <http://www.kfs.oeaw.ac.at>`_, Austrian Academy University of Denmark, `ARI <http://www.kfs.oeaw.ac.at>`_, Austrian Academy
of Sciences and `I2M <http://www.i2m.univ-amu.fr>`_, Aix-Marseille Université. of Sciences and `I2M <http://www.i2m.univ-amu.fr>`_, Aix-Marseille Université.
......
ltfatpy:1.0.3 ltfatpy:1.0.4
ltfat:2.1.0 ltfat:2.1.0
...@@ -68,14 +68,28 @@ def getVersionsAndDate(): ...@@ -68,14 +68,28 @@ def getVersionsAndDate():
v_dict['ltfat']) v_dict['ltfat'])
def writeCopyrightRst(date, ltfatpy_version, ltfat_version):
stamp = open("copyrightstamp.txt").read()
stamp = stamp.replace("DATE", date)
stamp = stamp.replace("LTFATPY_VERSION", ltfatpy_version)
stamp = stamp.replace("LTFAT_VERSION", ltfat_version)
docfile = os.path.join(os.path.dirname(os.path.abspath(__file__)),
"doc", "copyright.rst")
f = open(docfile, 'w')
f.write(stamp)
f.close()
def writeStamp(): def writeStamp():
""" Write a copyright stamp on all files """ """ Write a copyright stamp on all files """
stamp = getStamp(*getVersionsAndDate()) (date, ltfatpy_version, ltfat_version) = getVersionsAndDate()
stamp = getStamp(date, ltfatpy_version, ltfat_version)
files = findFiles(os.path.join(os.path.dirname(os.path.abspath(__file__)), files = findFiles(os.path.join(os.path.dirname(os.path.abspath(__file__)),
"ltfatpy")) "ltfatpy"))
for filename in files: for filename in files:
fileStamping(filename, stamp) fileStamping(filename, stamp)
fileStamping("setup.py", stamp) fileStamping("setup.py", stamp)
writeCopyrightRst(date, ltfatpy_version, ltfat_version)
def eraseStamp(): def eraseStamp():
......
Copyright ######### COPYRIGHT #########
#########
Copyright(c) 2015 Copyright(c) 2016:
----------------- -----------------
* LabEx Archimède: http://labex-archimede.univ-amu.fr/ * LabEx Archimède: http://labex-archimede.univ-amu.fr/
...@@ -10,28 +9,28 @@ Copyright(c) 2015 ...@@ -10,28 +9,28 @@ Copyright(c) 2015
* Université d'Aix-Marseille : http://www.univ-amu.fr/ * Université d'Aix-Marseille : http://www.univ-amu.fr/
This software is a port from LTFAT 2.1.0 : This software is a port from LTFAT 2.1.0 :
Copyright (C) 2005-2015 Peter L. Soendergaard <peter_AT_sonderport.dk>. Copyright (C) 2005-2016 Peter L. Soendergaard <peter@sonderport.dk>.
Contributors Contributors:
------------ ------------
* Denis Arrivault <contact.dev_AT_lif.univ-mrs.fr> * Denis Arrivault <contact.dev_AT_lif.univ-mrs.fr>
* Florent Jaillet <contact.dev_AT_lif.univ-mrs.fr> * Florent Jaillet <contact.dev_AT_lif.univ-mrs.fr>
Description Description:
----------- -----------
ltfatpy is a partial Python port of the Large Time/Frequency Analysis Toolbox ltfatpy is a partial Python port of the Large Time/Frequency Analysis Toolbox
(http://ltfat.sourceforge.net/), a MATLAB®/Octave toolbox for working with (http://ltfat.sourceforge.net/), a MATLAB®/Octave toolbox for working with
time-frequency analysis and synthesis. time-frequency analysis and synthesis.
Versions Version:
-------- -------
* ltfatpy version = 1.0.0 * ltfatpy version = 1.0.4
* LTFAT version = 2.1.0 * LTFAT version = 2.1.0
Licence Licence:
------- -------
This program is free software: you can redistribute it and/or modify This program is free software: you can redistribute it and/or modify
...@@ -46,3 +45,5 @@ GNU General Public License for more details. ...@@ -46,3 +45,5 @@ GNU General Public License for more details.
You should have received a copy of the GNU General Public License You should have received a copy of the GNU General Public License
along with this program. If not, see <http://www.gnu.org/licenses/>. along with this program. If not, see <http://www.gnu.org/licenses/>.
######### COPYRIGHT #########
\ No newline at end of file
...@@ -12,30 +12,30 @@ Before installing **ltfatpy** you must check that the following software are ins ...@@ -12,30 +12,30 @@ Before installing **ltfatpy** you must check that the following software are ins
CMake CMake
----- -----
A version of `cmake <https://cmake.org/>`_ >= 2.6 is required to install **ltfatpy**. A version of `cmake <https://cmake.org/>`_ >= 2.6 is required to install **ltfatpy**.
To install **CMake** follow the instructions given `here <https://cmake.org/install/>`_ To install **CMake** follow the instructions given `here <https://cmake.org/install/>`_.
Python Python
------ ------
* Make sure you have **python** >= 2.7 installed. If not follow the instructions from `here <https://wiki.python.org/moin/BeginnersGuide/Download>`_ * Make sure you have **python** >= 2.7 installed. If not follow the instructions from `here <https://wiki.python.org/moin/BeginnersGuide/Download>`_.
* According to your python version, make sure you have **pip** installed. If not follow the instructions from `here <https://pip.pypa.io/en/stable/installing/>`_ * According to your python version, make sure you have **pip** installed. If not follow the instructions from `here <https://pip.pypa.io/en/stable/installing/>`_.
For developpers only: For developpers only:
* If you need to recompile the whole ltfatpy C kernel interface you have to install **cython** >= 0.21. * If you need to recompile the whole ltfatpy C kernel interface you have to install **cython** >= 0.21.
* It can be installed by following the instructions given `here <http://docs.cython.org/src/quickstart/install.html>`_ * It can be installed by following the instructions given `here <http://docs.cython.org/src/quickstart/install.html>`_.
Scientific Python libraries Scientific Python libraries
--------------------------- ---------------------------
**ltfatpy** is using **numpy** >= 1.9, **scipy** >= 0.15 and **matplotlib** >= 1.4. For installing those packages read the instructions in: **ltfatpy** is using **numpy** >= 1.9, **scipy** >= 0.15 and **matplotlib** >= 1.4. For installing those packages read the instructions in:
`here <http://www.scipy.org/install.html>`_ `here <http://www.scipy.org/install.html>`_.
Downloading **ltfatpy** Downloading **ltfatpy**
======================== ========================
* The last stable release of **ltfatpy** is available on `PyPI <https://pypi.python.org/pypi/ltfatpy>`_ * The last stable release of **ltfatpy** is available on `PyPI <https://pypi.python.org/pypi/ltfatpy>`_.
* You can clone the git repository of **ltfatpy** from `here <https://gitlab.lif.univ-mrs.fr/dev/ltfatpy>`_ * You can clone the git repository of **ltfatpy** from `here <https://gitlab.lif.univ-mrs.fr/dev/ltfatpy>`_.
Installing **ltfatpy** Installing **ltfatpy**
======================== ========================
...@@ -43,20 +43,20 @@ Installing **ltfatpy** ...@@ -43,20 +43,20 @@ Installing **ltfatpy**
From sources From sources
------------ ------------
From ltfatpy-x.x.x/ directory use `pip install -e .` From ltfatpy-x.x.x/ directory use ``pip install -e .``
From PyPI From PyPI
--------- ---------
Just use : `pip install ltfatpy` Just use : ``pip install ltfatpy``
Building documentation with Sphinx Building documentation with Sphinx
================================== ==================================
Make sure you have Sphinx installed as described `here <http://sphinx-doc.org/tutorial.html#install-sphinx>`. Make sure you have Sphinx installed as described `here <http://sphinx-doc.org/tutorial.html#install-sphinx>`_.
Before building documentation you have to install **sphinxcontrib-bibtex** : Before building documentation you have to install **sphinxcontrib-bibtex** :
``pip install sphinxcontrib-bibtex `` ``pip install sphinxcontrib-bibtex``
Then you have to use the setup.py build_sphinx command : Then you have to use the setup.py build_sphinx command :
``python setup.py build_sphinx`` ``python setup.py build_sphinx``
\ No newline at end of file
...@@ -10,7 +10,7 @@ The package provides a large number of linear transforms including Gabor ...@@ -10,7 +10,7 @@ The package provides a large number of linear transforms including Gabor
transforms along with routines for constructing windows (filter prototypes) transforms along with routines for constructing windows (filter prototypes)
and routines for manipulating coefficients. and routines for manipulating coefficients.
The orginal LTFAT Toolbox for MATLAB®/Octave is developed at The original LTFAT Toolbox for MATLAB®/Octave is developed at
`CAHR <http://www.dtu.dk/centre/cahr/English.aspx>`_, Technical `CAHR <http://www.dtu.dk/centre/cahr/English.aspx>`_, Technical
University of Denmark, `ARI <http://www.kfs.oeaw.ac.at>`_, Austrian Academy University of Denmark, `ARI <http://www.kfs.oeaw.ac.at>`_, Austrian Academy
of Sciences and `I2M <http://www.i2m.univ-amu.fr>`_, Aix-Marseille Université. of Sciences and `I2M <http://www.i2m.univ-amu.fr>`_, Aix-Marseille Université.
......
...@@ -268,7 +268,7 @@ def setup_package(): ...@@ -268,7 +268,7 @@ def setup_package():
"ltfatpy.tools"], "ltfatpy.tools"],
package_data={'ltfatpy.signals': ['*.wav'], package_data={'ltfatpy.signals': ['*.wav'],
'ltfatpy.comp': ['*.pxd']}, 'ltfatpy.comp': ['*.pxd']},
url="https://gitlab.lif.univ-mrs.fr/dev/ltfatpy.git", url="https://gitlab.lif.univ-mrs.fr/dev/ltfatpy",
license='GNU GPL V3', license='GNU GPL V3',
author='Denis Arrivault and Florent Jaillet', author='Denis Arrivault and Florent Jaillet',
author_email='denis.arrivault@lif.univ-mrs.fr ' + author_email='denis.arrivault@lif.univ-mrs.fr ' +
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment