Metadata-Version: 2.4
Name: mesh2scattering
Version: 1.0.4
Summary: Numerical calculation of surface scattering.
License-Expression: MIT
Project-URL: Tracker, https://github.com/ahms5/mesh2scattering/issues
Project-URL: Documentation, https://mesh2scattering.readthedocs.io/
Project-URL: Download, https://pypi.org/project/mesh2scattering/
Project-URL: Source, https://github.com/ahms5/mesh2scattering
Project-URL: Changelog, https://github.com/ahms5/mesh2scattering/blob/master/CHANGELOG.md
Keywords: acoustics,pyfar
Classifier: Development Status :: 4 - Beta
Classifier: Intended Audience :: Science/Research
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Requires-Python: >=3.9
Description-Content-Type: text/markdown
Requires-Dist: numpy>=1.14.0
Requires-Dist: scipy>=1.5.0
Requires-Dist: matplotlib
Requires-Dist: pyfar<0.8.0
Requires-Dist: psutil
Requires-Dist: sofar
Requires-Dist: netCDF4!=1.7.4
Requires-Dist: trimesh
Requires-Dist: pooch
Provides-Extra: deploy
Requires-Dist: twine; extra == "deploy"
Requires-Dist: wheel; extra == "deploy"
Requires-Dist: build; extra == "deploy"
Requires-Dist: setuptools; extra == "deploy"
Requires-Dist: bump-my-version; extra == "deploy"
Provides-Extra: tests
Requires-Dist: pytest; extra == "tests"
Requires-Dist: pytest-cov; extra == "tests"
Requires-Dist: watchdog; extra == "tests"
Requires-Dist: ruff==0.9.8; extra == "tests"
Requires-Dist: coverage; extra == "tests"
Requires-Dist: nbmake>=0.7.0; extra == "tests"
Provides-Extra: docs
Requires-Dist: sphinx; extra == "docs"
Requires-Dist: autodocsumm>=0.2.14; extra == "docs"
Requires-Dist: pydata-sphinx-theme; extra == "docs"
Requires-Dist: sphinx_mdinclude; extra == "docs"
Requires-Dist: sphinx-design; extra == "docs"
Requires-Dist: sphinx-favicon; extra == "docs"
Requires-Dist: sphinx-reredirects; extra == "docs"
Requires-Dist: nbsphinx; extra == "docs"
Requires-Dist: sphinx_gallery; extra == "docs"
Requires-Dist: nbsphinx_link; extra == "docs"
Requires-Dist: ipython; extra == "docs"
Provides-Extra: dev
Requires-Dist: mesh2scattering[deploy,docs,tests]; extra == "dev"

# Mesh2scattering

[![PyPI version](https://badge.fury.io/py/mesh2scattering.svg)](https://badge.fury.io/py/mesh2scattering)
[![Documentation Status](https://readthedocs.org/projects/mesh2scattering/badge/?version=latest)](https://mesh2scattering.readthedocs.io/en/latest/?badge=latest)
[![CircleCI](https://circleci.com/gh/ahms5/mesh2scattering.svg?style=shield)](https://circleci.com/gh/ahms5/mesh2scattering)
[![Binder](https://mybinder.org/badge_logo.svg)](https://mybinder.org/v2/gh/pyfar/gallery/main?labpath=docs/gallery/interactive/pyfar_introduction.ipynb)

Mesh2scattering is based on [Mesh2HRTF](https://github.com/Any2HRTF/Mesh2HRTF) and is an open-source project aiming an easy-to-use software package for the numerical calculation of scattering pattern and scattering and diffusion coefficients of any surface. In a nutshell, Mesh2scattering consists of five parts:

- input: prepares geometrical data and acoustic parameters for the simulation,
- numcalc: based on the input from ``input``, it calculates the corresponding sound field
- output: processes the output from NumCalc to scattering pattern.
- process: processes the output to scattering and/or diffusion coefficients.
- utils: helping functions.

Please notice that this project does not support HRTF post processing, use [Mesh2HRTF](https://github.com/Any2HRTF/Mesh2HRTF) instead.

## Getting Started

Check out the examples folder for a tour of the most important mesh2scattering
functionality and [read the docs](https://mesh2scattering.readthedocs.io/en/latest) for the complete documentation.

## Installation

Use pip to install mesh2scattering

```bash
pip install mesh2scattering
```

(Requires Python 3.9 or higher)

For Windows the exe is downloaded automatically.
For Linux and MacOS NumCalc is build automatically, note that this requires
the ``build-essential`` on Linux and ``xcode`` on mac.
In the [contributing guidelines](https://mesh2scattering.readthedocs.io/en/stable/contributing.html), you will find a complete Instructions for
manual building.

## Contributing

Check out the [contributing guidelines](https://mesh2scattering.readthedocs.io/en/stable/contributing.html).
