diff --git a/mosqito/classes/__init__.py b/mosqito/classes/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/functions/__init__.py b/mosqito/functions/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/functions/loudness_zwicker/__init__.py b/mosqito/functions/loudness_zwicker/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/functions/noctfilter/__init__.py b/mosqito/functions/noctfilter/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/functions/oct3filter/__init__.py b/mosqito/functions/oct3filter/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/functions/roughness_danielweber/__init__.py b/mosqito/functions/roughness_danielweber/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/functions/shared/__init__.py b/mosqito/functions/shared/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/functions/sharpness/__init__.py b/mosqito/functions/sharpness/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/functions/tonality_tnr_pr/__init__.py b/mosqito/functions/tonality_tnr_pr/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/methods/Audio/__init__.py b/mosqito/methods/Audio/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/methods/__init__.py b/mosqito/methods/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/tests/Audio/__init__.py b/mosqito/tests/Audio/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/tests/__init__.py b/mosqito/tests/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/tests/loudness/__init__.py b/mosqito/tests/loudness/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/tests/loudness/data/ISO_532-1/__init__.py b/mosqito/tests/loudness/data/ISO_532-1/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/tests/loudness/data/__init__.py b/mosqito/tests/loudness/data/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/tests/loudness/data/sound-synthesis/__init__.py b/mosqito/tests/loudness/data/sound-synthesis/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/tests/roughness/__init__.py b/mosqito/tests/roughness/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/tests/sharpness/__init__.py b/mosqito/tests/sharpness/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/mosqito/tests/tonality_tnr_pr/__init__.py b/mosqito/tests/tonality_tnr_pr/__init__.py new file mode 100644 index 00000000..e69de29b diff --git a/readme.md b/readme.md index 5126ab29..feebb872 100644 --- a/readme.md +++ b/readme.md @@ -1,4 +1,4 @@ -# ![MOSQITO Logo](./logo.png) MOSQITO +# ![MOSQITO Logo](https://raw.githubusercontent.com/Eomys/MoSQITo/master/logo.png) MOSQITO ## Background @@ -44,32 +44,31 @@ machine simulation software. Tutorials are available in the [tutorials](./tutorials/) folder. Documentation and validation of the MOSQITO functions are available in the [documentation](./documentation/) folder. - ## Scope The scope of the project is to implement the following first set of metrics: -|| Reference | Validated | Available | Under dev. | To do | -|:-|:-|:-:|:-:|:-:|:-:| -|Loudness for
steady signals
(Zwicker method) | ISO 532B:1975
DIN 45631:1991
ISO 532-1:2017 §5 | [x](./mosqito/validations/loudness_zwicker/output) | [x](./documentation/loudness-stationary.md) || -|Loudness for non-stationary
(Zwicker method) | DIN 45631/A1:2010
ISO 532-1:2017 §6 | [x](./mosqito/validations/loudness_zwicker/output) | [x](./documentation/loudness-time-varying.md) ||| -| Roughness | Daniel and Weber, 1997 | [x](./mosqito/validations/roughness_danielweber) | [x](./documentation/roughness.md) ||| -| Fluctuation Strength | To be defined |||| x | -| Sharpness | DIN 45692:2009 | [x](./mosqito/validations/sharpness/output) | [x](./documentation/sharpness.md) ||| -| Tonality (Hearing model) | ECMA-74:2019 annex G ||| x || +| | Reference | Validated | Available | Under dev. | To do | +|:-------------------------------------------------- |:---------------------------------------------------- |:--------------------------------------------------:|:---------------------------------------------:|:----------:|:-----:| +| Loudness for
steady signals
(Zwicker method) | ISO 532B:1975
DIN 45631:1991
ISO 532-1:2017 §5 | [x](./mosqito/validations/loudness_zwicker/output) | [x](./documentation/loudness-stationary.md) | | | +| Loudness for non-stationary
(Zwicker method) | DIN 45631/A1:2010
ISO 532-1:2017 §6 | [x](./mosqito/validations/loudness_zwicker/output) | [x](./documentation/loudness-time-varying.md) | | | +| Roughness | Daniel and Weber, 1997 | [x](./mosqito/validations/roughness_danielweber) | [x](./documentation/roughness.md) | | | +| Fluctuation Strength | To be defined | | | | x | +| Sharpness | DIN 45692:2009 | [x](./mosqito/validations/sharpness/output) | [x](./documentation/sharpness.md) | | | +| Tonality (Hearing model) | ECMA-74:2019 annex G | | | x | | As a second priority, the project could address the following metrics: -|| Reference | Validated | Available | Under dev. | To do | -|:-|:-|:-:|:-:|:-:|:-:| -|Loudness for steady signals
(Moore/Glasberg method) | ISO 532-2:2017 ||||x| -|Loudness for non-stationary
(Moore/Glasberg method) | Moore, 2014 ||||x| -|Sharpness (using
Moore/Glasberg loudness) | Hales-Swift
and Gee, 2017 ||||x| -|Tone-to-noise ratio / Prominence
ratio (occupational noise,
discrete tones) | ECMA-74:2019 annex D
ISO 7719:2018 || x||| -|Tone-to-noise ratio
(environmental noise,
automatic tone detection) | DIN 45681 ||||x| -|Tone-to-noise ratio
(environmental noise) | ISO 1996-2 ||||x| -|Tone-to-noise ratio
(environmental noise) | ANSI S1.13:2005 ||||x| +| | Reference | Validated | Available | Under dev. | To do | +|:----------------------------------------------------------------------------------- |:------------------------------------- |:---------:|:---------:|:----------:|:-----:| +| Loudness for steady signals
(Moore/Glasberg method) | ISO 532-2:2017 | | | | x | +| Loudness for non-stationary
(Moore/Glasberg method) | Moore, 2014 | | | | x | +| Sharpness (using
Moore/Glasberg loudness) | Hales-Swift
and Gee, 2017 | | | | x | +| Tone-to-noise ratio / Prominence
ratio (occupational noise,
discrete tones) | ECMA-74:2019 annex D
ISO 7719:2018 | | x | | | +| Tone-to-noise ratio
(environmental noise,
automatic tone detection) | DIN 45681 | | | | x | +| Tone-to-noise ratio
(environmental noise) | ISO 1996-2 | | | | x | +| Tone-to-noise ratio
(environmental noise) | ANSI S1.13:2005 | | | | x | In parallel, tools for signal listening and manipulation will be developed. The objective is to be able to apply some modification to a diff --git a/requirements.txt b/requirements.txt index 35d8ba61..871431af 100644 --- a/requirements.txt +++ b/requirements.txt @@ -3,4 +3,6 @@ scipy pytest matplotlib pyuff -scidatatool \ No newline at end of file +scidatatool +h5py +cloudpickle \ No newline at end of file diff --git a/setup.py b/setup.py index 70160cd1..77c6c2b1 100644 --- a/setup.py +++ b/setup.py @@ -1,32 +1,35 @@ import setuptools -import platform +# /!\ update before a release +MoSQITo_VERSION = "0.2.0" + +# MoSQITo description with open("README.md", "r", encoding="utf-8") as fh: long_description = fh.read() python_requires = ">= 3.5" -# Pyleecan dependancies -install_requires = [ - "setuptools", - "numpy>=1.18.1", - "scipy>=1.4.1", - "matplotlib>=3.1.3", - "pandas", -] +# MoSQITo dependancies +with open("requirements.txt", "r") as file: + requirements = file.readlines() + install_requires = "".join( + requirements + ).splitlines() # remove endline in each element -tests_require = ["pytest>=5.4.1"] +tests_require = ["pytest>=5.4.1","pandas", "openpyxl"] setuptools.setup( name="mosqito", - version="0.1.0", + version=MoSQITo_VERSION, author="MoSQITo Developers", author_email="martin.glesser@eomys.com", description="Modular Sound Quality Integrated Toolbox", long_description=long_description, long_description_content_type="text/markdown", url="https://github.com/Eomys/MoSQITo", - download_url="https://github.com/Eomys/MoSQITo/archive/v0.1.0.tar.gz", + download_url="https://github.com/Eomys/MoSQITo/archive/v{}.tar.gz".format( + MoSQITo_VERSION + ), packages=setuptools.find_packages(exclude=["documentation", "tutorials"]), include_package_data=True, classifiers=[ @@ -37,4 +40,7 @@ python_requires=python_requires, install_requires=install_requires, tests_require=tests_require, + extras_require={ + 'testing': tests_require + }, )