Skip to content

Commit

Permalink
Delete obsolete Exp3
Browse files Browse the repository at this point in the history
Add conda environment file
Update Readme
Raise of version number
  • Loading branch information
tluebeck committed Jul 30, 2019
1 parent 9614d67 commit adc1243
Show file tree
Hide file tree
Showing 6 changed files with 64 additions and 295 deletions.
28 changes: 15 additions & 13 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,7 @@ The following external libraries are required:

- `NumPy`_
- `SciPy`_
- `Pysofaconventions`_
- `Plotly`_ (for plotting)


Expand All @@ -36,8 +37,8 @@ For performance and convenience reasons we highly recommend to use
Once installed, you can use the following steps to create a new environment
with the *sfa* toolbox.

#. Create a new environment:
``conda create --name sfa python numpy scipy plotly``
#. Create new Conda environment from the specified requirements:
``conda env create --file environment.yml``

#. Activate the environment:
``source activate sfa``
Expand Down Expand Up @@ -77,7 +78,7 @@ course also simply download the examples and run them locally!


Exp1: Ideal plane wave
~~~~~~~~~~~~~~~~~~~~~
~~~~~~~~~~~~~~~~~~~~~~

Ideal unity plane wave simulation and 3D plot.

Expand All @@ -103,25 +104,25 @@ a cardioid mic.
.. _AE3_img: https://nbviewer.jupyter.org/github/AppliedAcousticsChalmers/sound_field_analysis-py/blob/master/examples/Exp2_MeasuredWave.ipynb


Exp3: Import data in SOFA format
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

The provided example loading a SOFA_ file is outdated. We recommend using the
`pysofaconventions <https://github.com/andresperezlopez/pysofaconventions>`_
package. See repository for examples and install instructions.


Exp4: Binaural rendering
^^^^^^^^^^^^^^^^^^^^^^^^

Render a spherical microphone array measurement for binaural reproduction.
Render a spherical microphone array measurement for binaural reproduction. The example shows examples for loading miro or `SOFA`_ files.

`View interactively on nbviewer <https://nbviewer.jupyter.org/github/AppliedAcousticsChalmers/sound_field_analysis-py/blob/master/examples/Exp4_BinauralRendering.ipynb>`__


Version history
---------------

*2019-07-30 V0.9*
* Implement SOFA import
* Update Exp4 to contain SOFA import
* Delete obsolete Exp3
* Add named tuple HRIRSignal
* Implement cart2sph and sph2cart utility functions
* Add conda environment file for convenient installation of required packages

*2019-07-11 V0.8*
* Implement Spherical Harmonics coefficients tapering
* Adaption of associated Spherical Head Filter
Expand All @@ -137,7 +138,7 @@ Version history
* Implement Spherical Head Filter
* Implement Spherical Fourier Transform using pseudo-inverse
* Extract real time capable Spatial Fourier Transform
* Outsource reversed m index function (Exp. 4)
* Outsource reversed m index function (Exp4)


References
Expand All @@ -153,6 +154,7 @@ The Lebedev grid generation was adapted from an implementation by `Richard P. Mu
.. _[1]: #references
.. _NumPy: http://www.numpy.org
.. _SciPy: http://www.scipy.org
.. _Pysofaconventions: https://github.com/andresperezlopez/pysofaconventions
.. _Plotly: https://plot.ly/python/
.. _Conda: https://www.continuum.io/downloads
.. _conda-forge: https://conda-forge.github.io
Expand Down
12 changes: 12 additions & 0 deletions environment.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
name: sfa
channels:
- defaults
dependencies:
- python
- numpy
- scipy
- plotly
- pip
- pip:
- pysofaconventions >= 0.1.5
- -e .
240 changes: 0 additions & 240 deletions examples/Exp3_Import_SOFA.ipynb

This file was deleted.

Loading

0 comments on commit adc1243

Please sign in to comment.