From 2dffad8173d48672e00d4e77f14456f63a898a3e Mon Sep 17 00:00:00 2001 From: John Glover Date: Thu, 12 Jul 2012 20:09:35 +0100 Subject: [docs] Update readme. --- README.md | 93 ----------------------------------------------------------- README.rst | 97 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 2 files changed, 97 insertions(+), 93 deletions(-) delete mode 100644 README.md create mode 100644 README.rst diff --git a/README.md b/README.md deleted file mode 100644 index e7de851..0000000 --- a/README.md +++ /dev/null @@ -1,93 +0,0 @@ -Sinusoidal Modelling - A Python Library (SiMPL) -=============================================== - -Version 0.3 - -Copyright (c) 2012 John Glover, National University of Ireland, Maynooth -http://simplsound.sourceforge.net -j@johnglover.net - - -Introduction ------------- - -Simpl is an open source library for sinusoidal modelling written in C/C++ and Python, -and making use of Scientific Python (SciPy). The aim of this -project is to tie together many of the existing sinusoidal modelling implementations -into a single unified system with a consistent API, as well as providing implementations -of some recently published sinusoidal modelling algorithms, many of which have yet -to be released in software. Simpl is primarily intended as a tool for other researchers -in the field, allowing them to easily combine, compare and contrast many of the published -analysis/synthesis algorithms. - - -Dependencies ------------- - -* C/C++ compiler -* Python (>= 2.6.*) -* NumPy -* SciPy -* GNU Scientific Library (for libsms) -* Developers who wish to run the unit tests also need the original open source libraries: - * sndobj: http://sndobj.sourceforge.net/ - * libsms: http://mtg.upf.edu/static/libsms/ - - -Installation ------------- - -First build the extension module (so that the SWIG wrapper files are created) by running -the following command in the root folder: - - $ python setup.py build - -Then to install the module in your Python site-packages directory: - - $ python setup.py install - - -Usage ------ - -See the scripts in the examples folder. - - -Credits -------- - -The SndObj library is by Dr. Victor Lazzarini (National University of Ireland, Maynooth) and others. -See the main project page at http://sndobj.sourceforge.net/ for more information. - -Libsms is an implementation of SMS by Rich Eakin, based on code by Dr. Xavier Serra (MTG, -Universitat Pompeu Fabra, Barcelona, Spain) -See the main project page at http://mtg.upf.edu/static/libsms for more information. - -The MQ algorithm is based on the following paper: -R. McAulay, T. Quatieri, "Speech Analysis/Synthesis Based on a Sinusoidal Representation", -IEEE Transaction on Acoustics, Speech and Signal Processing, vol. 34, no. 4, pp. 744-754, 1986. - - -To Do ------ - -general: - -* include new RT Audio code -* tidy up code for HMM/LP partial tracking and Loris integration -* include binaries for Mac OS X and Windows so compilation from source is not needed -* performance issues: MQ, LP and HMM algorithms need to be coded in C/C++ really, - Python is just too slow, particularly for real-time use. The pure Python implementations - are useful for testing though. - -sndobj: - -* create exception objects -* add a set_synthesis_type property to SndObjSynthesis -* create properties for threshold and num_bins in SndObjPartialTracking class -* make sndobjs use self.sampling_rate -* make peak detection use the new window_size property - -sms: - -* move sms_scaleDet to the harmonic analysis phase diff --git a/README.rst b/README.rst new file mode 100644 index 0000000..fad901a --- /dev/null +++ b/README.rst @@ -0,0 +1,97 @@ +Sinusoidal Modelling - A Python Library (SiMPL) +=============================================== + +Version 0.3 (alpha) + +http://simplsound.sourceforge.net + + +Introduction +------------ + +Simpl is an open source library for sinusoidal modelling written in C/C++ and Python, +and making use of Scientific Python (SciPy). The aim of this +project is to tie together many of the existing sinusoidal modelling implementations +into a single unified system with a consistent API, as well as providing implementations +of some recently published sinusoidal modelling algorithms, many of which have yet +to be released in software. Simpl is primarily intended as a tool for other researchers +in the field, allowing them to easily combine, compare and contrast many of the published +analysis/synthesis algorithms. + + +C++ Library Dependencies +------------------------ + +* CMake_ +* fftw3_ +* GNU Scientific Library (for libsms) + +.. _CMake: http://www.cmake.org +.. _fftw3: http://www.fftw.org + + +Additional Python Module Dependencies +------------------------------------- + +* Python (>= 2.6.*) +* Cython_ +* NumPy +* SciPy + +.. _Cython: http://cython.org + + +Additional Test Dependencies +---------------------------- + +* sndobj_ +* libsms_ + +.. _sndobj: http://sndobj.sourceforge.net +.. _libsms: http://mtg.upf.edu/static/libsms + + +Installation +------------ + +To build and install the C++ module, from the simpl root folder run: + +:: + + $ mkdir build + $ cd build + $ cmake .. + $ make + $ sudo make install + +To build and install the Python module, from the simpl root folder run: + +:: + + $ python setup.py build + $ python setup.py install + + +Usage +----- + +See the scripts in the examples folder. + + +Credits +------- + +The SndObj library is by Dr. Victor Lazzarini (National University of Ireland, Maynooth) and others. +See the main project page at http://sndobj.sourceforge.net/ for more information. + +Libsms is an implementation of SMS by Rich Eakin, based on code by Dr. Xavier Serra (MTG, +Universitat Pompeu Fabra, Barcelona, Spain) +See the main project page at http://mtg.upf.edu/static/libsms for more information. + +The MQ algorithm is based on the following paper: +R. McAulay, T. Quatieri, "Speech Analysis/Synthesis Based on a Sinusoidal Representation", +IEEE Transaction on Acoustics, Speech and Signal Processing, vol. 34, no. 4, pp. 744-754, 1986. + +Everything else: Copyright (c) 2012 John Glover, National University of Ireland, Maynooth + +john dot c dot glover @ nuim dot net -- cgit v1.2.3