Metadata-Version: 2.1
Name: quantum_inferno
Version: 1.0
Summary: Quantized Information Entropy, Nth Octave (INFERNO)
Author-email: "ISLA, UH" <milton@isla.hawaii.edu>
License: MIT License
        
        Copyright (c) 2023 Infrasound Laboratory, HIGP, SOEST, University of Hawaii at Manoa
        
        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.
        
Project-URL: homepage, https://github.com/ISLA-UH/quantum-inferno.git
Project-URL: PyPI, https://pypi.org/project/quantum-inferno/
Requires-Python: <=3.12,>=3.8
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: librosa==0.10.2
Requires-Dist: matplotlib==3.9.1
Requires-Dist: numpy==1.26.4
Requires-Dist: pyproj~=3.6.1
Requires-Dist: scipy==1.13.1
Requires-Dist: setuptools==70.3.0
Requires-Dist: tftb==0.1.3

# quantum-inferno
## Quantized Information Entropy, Nth Octave

### Caveat Emptor: Early Release Dev Version

### Description
Computes standardized time-frequency representations (TFRs) for power, information, and entropy, 
built on the Gabor wavelets with minimal time-frequency uncertainty with 
logarithmic constant-Q base 2 (binary) scales and frequency bands of quantized order N.

All algorithms are based on FFTs for computational efficiency. 
The short-term Fourier transform (STFT) is included as the baseline TFR.
Algorithms for the Continuous Wavelet Transform (CWT), Discrete Wavelet Transform (DWT), 
and Stockwell Transform (STX) are provided.

Refer to the open access publications:

- [Garcés, M.A. Quantized Information in Spectral Cyberspace. Entropy 2023, 25, 419](https://doi.org/10.3390/e25030419)

- [Garcés, M.A. Quantized Constant-Q Gabor Atoms for 
Sparse Binary Representations of Cyber-Physical Signatures. Entropy 2020, 22, 936](https://doi.org/10.3390/e22090936)

- [Garcés, M.A. On Infrasound Standards, Part 1 Time, Frequency, and Energy Scaling. 
Inframatics 2013, 2, 13-35](https://doi.org/10.4236/inframatics.2013.22002)
 
Recommended background reading in chronological order:
- Gabor, D. Theory of Communication, Part 3. Electr. Eng. 1946, 93, 445–457.
- Shannon, C.E. The Mathematical Theory of Communication; University of Illinois Press: Urbana, IL, USA, 1998; [1949 first ed].
- Harris, F. J. On the Use of Windows for Harmonic Analysis with the Discrete Fourier Transform, Proceedings of the IEEE, 1978, 66 (1), 51-83.
- Cohen, L. Time-Frequency Analysis, Prentice-Hall, NI 07458, 1995.
- Stockwell, R. G., Mansina, L, and R. P. Lowe. Localization of the Complex Spectrum: The S Transform. Signal Processing, IEEE Transactions, 1996, 44 no. 4, 998-1001.
- Mallat, S. A Wavelet Tour of Signal Processing: The Sparse Way, 3rd ed.; Academic Press: Cambridge, MA, USA, 2009 [1998 first ed].


### Installation
```shell script
pip install quantum-inferno
```

More details will be placed in the [Installation guide](https://github.com/ISLA-UH/quantum-inferno/blob/main/docs/installation.md).

### Examples
Full examples can be found in the [examples documentation](https://github.com/ISLA-UH/quantum-inferno/blob/main/docs/examples.md#examples-using-quantum-inferno).

### API Documentation
Check the [API Documentation](https://ISLA-UH.github.io/quantum-inferno).

### Resources

- Found an issue? Submit a [bug report](https://github.com/ISLA-UH/quantum-inferno/issues).
- [MIT License](https://github.com/ISLA-UH/quantum-inferno/blob/main/LICENSE)
