added more information about the modules in this directory

Author: xserra

smstools/models/README.txt

@@ -1 +1,30 @@
-This directory includes the code for all the spectral models.
+# Spectral Models Module
+
+This directory contains the implementation of all spectral analysis/synthesis models used in the SMS Tools package.
+
+## Overview
+The models in this directory decompose, analyze, and resynthesize audio signals using various spectral techniques. Each model is implemented as a Python module with analysis, synthesis, and full model functions.
+
+## Main Models
+- `dftModel.py`: Discrete Fourier Transform (DFT) analysis and synthesis functions.
+- `sineModel.py`: Sinusoidal model for tracking and synthesizing sinusoidal components.
+- `harmonicModel.py`: Harmonic model for extracting and resynthesizing harmonic partials.
+- `stochasticModel.py`: Stochastic model for modeling the noise-like residual.
+- `sprModel.py`: Sinusoidal plus residual (SPR) model, combining sinusoidal and noise components.
+- `spsModel.py`: Sinusoidal plus stochastic (SPS) model.
+- `hprModel.py`: Harmonic plus residual (HPR) model.
+- `hpsModel.py`: Harmonic plus stochastic (HPS) model.
+- `stft.py`: Short-Time Fourier Transform utilities.
+- `utilFunctions.py`: Utility functions for windowing, synthesis, and other signal processing tasks.
+
+## Usage
+- Each model provides `*Anal`, `*Synth`, and full model functions (e.g., `sineModelAnal`, `sineModelSynth`, `sineModel`).
+- Use these modules as building blocks for sound analysis, transformation, and synthesis.
+- See the docstrings in each file for detailed API documentation and usage examples.
+
+## Requirements
+- Numpy, Scipy
+
+## References
+- Serra, X. (1997). "Musical Sound Modeling with Sinusoids plus Noise". In Musical Signal Processing, Swets & Zeitlinger.
+- SMS Tools documentation: https://www.upf.edu/web/mtg/sms-tools

smstools/transformations/README.txt

@@ -1 +1,30 @@
-This directory includes all the software to transform sounds using the models
+# Sound Transformations Module
+
+This directory contains all the software for transforming sounds using the various analysis/synthesis models implemented in the SMS Tools package.
+
+## Overview
+The transformation modules operate on the outputs of models such as sineModel, harmonicModel, stochasticModel, hpsModel, and others. They provide algorithms for modifying, morphing, and resynthesizing audio in the time-frequency domain.
+
+## Main Modules
+- `harmonicTransformations.py`: Transformations for harmonic model outputs (e.g., pitch shifting, time scaling, timbre modification).
+- `hpsTransformations.py`: Transformations for harmonic plus stochastic model outputs.
+- `sineTransformations.py`: Transformations for sine model outputs (e.g., frequency scaling, time stretching).
+- `stftTransformations.py`: Transformations using the short-time Fourier transform (STFT).
+- `stochasticTransformations.py`: Transformations for stochastic model outputs.
+
+## Usage
+Each module provides functions that take model analysis outputs (e.g., frequency, magnitude, phase tracks) and apply transformations such as:
+- Time scaling (stretching/compressing)
+- Frequency scaling (pitch shifting)
+- Morphing between two sounds
+- Timbre modification
+
+See the docstrings in each module for function-level documentation and usage examples.
+
+## Requirements
+- Numpy, Scipy
+- Use in conjunction with the analysis/synthesis models in `../models/`
+
+## References
+- Serra, X. (1997). "Musical Sound Modeling with Sinusoids plus Noise". In Musical Signal Processing, Swets & Zeitlinger.
+- SMS Tools documentation: https://www.upf.edu/web/mtg/sms-tools