diff --git a/README.rst b/README.rst index e821e38d667044ad6e8a5f7c737207e8e4fabfcf..606f70cf5bec9ff78e105031fe18b756edb590d3 100644 --- a/README.rst +++ b/README.rst @@ -9,7 +9,7 @@ The package provides a large number of linear transforms including Gabor transforms along with routines for constructing windows (filter prototypes) 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 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é. diff --git a/VERSION b/VERSION index e43c31e9c2a7fb1722e27f61fdf45f34b407b104..5d16e76c4d3340cfa040637eb9df74c7194e0788 100644 --- a/VERSION +++ b/VERSION @@ -1,2 +1,2 @@ -ltfatpy:1.0.3 +ltfatpy:1.0.4 ltfat:2.1.0 diff --git a/copyright.py b/copyright.py index 7b106692cf7ab632ef9ae56425a06d89bdd9b47f..430ca6e18f7280e0653402768c34301ce6b1990a 100644 --- a/copyright.py +++ b/copyright.py @@ -68,14 +68,28 @@ def getVersionsAndDate(): 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(): """ 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__)), "ltfatpy")) for filename in files: fileStamping(filename, stamp) fileStamping("setup.py", stamp) + writeCopyrightRst(date, ltfatpy_version, ltfat_version) def eraseStamp(): diff --git a/doc/copyright.rst b/doc/copyright.rst index 286b06062d61434deb575132a871239e65e6eca2..1dff262b7926dd5c09fb83a4ad11d92ba814cea2 100644 --- a/doc/copyright.rst +++ b/doc/copyright.rst @@ -1,7 +1,6 @@ -Copyright -######### +######### COPYRIGHT ######### -Copyright(c) 2015 +Copyright(c) 2016: ----------------- * LabEx Archimède: http://labex-archimede.univ-amu.fr/ @@ -10,28 +9,28 @@ Copyright(c) 2015 * Université d'Aix-Marseille : http://www.univ-amu.fr/ 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> * Florent Jaillet <contact.dev_AT_lif.univ-mrs.fr> -Description +Description: ----------- ltfatpy is a partial Python port of the Large Time/Frequency Analysis Toolbox (http://ltfat.sourceforge.net/), a MATLAB®/Octave toolbox for working with time-frequency analysis and synthesis. -Versions --------- +Version: +------- -* ltfatpy version = 1.0.0 +* ltfatpy version = 1.0.4 * LTFAT version = 2.1.0 -Licence +Licence: ------- This program is free software: you can redistribute it and/or modify @@ -46,3 +45,5 @@ GNU General Public License for more details. You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>. + +######### COPYRIGHT ######### \ No newline at end of file diff --git a/doc/install.rst b/doc/install.rst index 8a4b33b1861d17c0438ecbc1e75679e1cea18d4d..4a13cb67e9fad61e900c62153f706ea06ab06ea4 100644 --- a/doc/install.rst +++ b/doc/install.rst @@ -12,30 +12,30 @@ Before installing **ltfatpy** you must check that the following software are ins CMake ----- 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 ------ -* 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/>`_ +* 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/>`_. For developpers only: * 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 --------------------------- **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** ======================== -* 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>`_ +* 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>`_. Installing **ltfatpy** ======================== @@ -43,20 +43,20 @@ Installing **ltfatpy** From sources ------------ -From ltfatpy-x.x.x/ directory use `pip install -e .` +From ltfatpy-x.x.x/ directory use ``pip install -e .`` From PyPI --------- -Just use : `pip install ltfatpy` +Just use : ``pip install ltfatpy`` 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** : -``pip install sphinxcontrib-bibtex `` +``pip install sphinxcontrib-bibtex`` Then you have to use the setup.py build_sphinx command : -``python setup.py build_sphinx`` \ No newline at end of file +``python setup.py build_sphinx`` diff --git a/ltfatpy/__init__.py b/ltfatpy/__init__.py index d858bf1fbbadf1af949eec03de82e2578e8ba67b..31c06e909d95e2f857a20631859b71c8ae2f74c5 100644 --- a/ltfatpy/__init__.py +++ b/ltfatpy/__init__.py @@ -10,7 +10,7 @@ The package provides a large number of linear transforms including Gabor transforms along with routines for constructing windows (filter prototypes) 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 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é. diff --git a/setup.py b/setup.py index c9cc9807699ab174c331ad20f4f6a87dfc9fb5de..d800244248b849dee222f9417bdb3275e1b832fb 100755 --- a/setup.py +++ b/setup.py @@ -268,7 +268,7 @@ def setup_package(): "ltfatpy.tools"], package_data={'ltfatpy.signals': ['*.wav'], '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', author='Denis Arrivault and Florent Jaillet', author_email='denis.arrivault@lif.univ-mrs.fr ' +