Skip to content

Commit adc1243

Browse files
committed
Delete obsolete Exp3
Add conda environment file Update Readme Raise of version number
1 parent 9614d67 commit adc1243

File tree

6 files changed

+64
-295
lines changed

6 files changed

+64
-295
lines changed

README.rst

Lines changed: 15 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@ The following external libraries are required:
2525

2626
- `NumPy`_
2727
- `SciPy`_
28+
- `Pysofaconventions`_
2829
- `Plotly`_ (for plotting)
2930

3031

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

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

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

7879

7980
Exp1: Ideal plane wave
80-
~~~~~~~~~~~~~~~~~~~~~
81+
~~~~~~~~~~~~~~~~~~~~~~
8182

8283
Ideal unity plane wave simulation and 3D plot.
8384

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

105106

106-
Exp3: Import data in SOFA format
107-
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
108-
109-
The provided example loading a SOFA_ file is outdated. We recommend using the
110-
`pysofaconventions <https://github.com/andresperezlopez/pysofaconventions>`_
111-
package. See repository for examples and install instructions.
112-
113-
114107
Exp4: Binaural rendering
115108
^^^^^^^^^^^^^^^^^^^^^^^^
116109

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

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

121114

122115
Version history
123116
---------------
124117

118+
*2019-07-30 V0.9*
119+
* Implement SOFA import
120+
* Update Exp4 to contain SOFA import
121+
* Delete obsolete Exp3
122+
* Add named tuple HRIRSignal
123+
* Implement cart2sph and sph2cart utility functions
124+
* Add conda environment file for convenient installation of required packages
125+
125126
*2019-07-11 V0.8*
126127
* Implement Spherical Harmonics coefficients tapering
127128
* Adaption of associated Spherical Head Filter
@@ -137,7 +138,7 @@ Version history
137138
* Implement Spherical Head Filter
138139
* Implement Spherical Fourier Transform using pseudo-inverse
139140
* Extract real time capable Spatial Fourier Transform
140-
* Outsource reversed m index function (Exp. 4)
141+
* Outsource reversed m index function (Exp4)
141142

142143

143144
References
@@ -153,6 +154,7 @@ The Lebedev grid generation was adapted from an implementation by `Richard P. Mu
153154
.. _[1]: #references
154155
.. _NumPy: http://www.numpy.org
155156
.. _SciPy: http://www.scipy.org
157+
.. _Pysofaconventions: https://github.com/andresperezlopez/pysofaconventions
156158
.. _Plotly: https://plot.ly/python/
157159
.. _Conda: https://www.continuum.io/downloads
158160
.. _conda-forge: https://conda-forge.github.io

environment.yml

Lines changed: 12 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,12 @@
1+
name: sfa
2+
channels:
3+
- defaults
4+
dependencies:
5+
- python
6+
- numpy
7+
- scipy
8+
- plotly
9+
- pip
10+
- pip:
11+
- pysofaconventions >= 0.1.5
12+
- -e .

examples/Exp3_Import_SOFA.ipynb

Lines changed: 0 additions & 240 deletions
This file was deleted.

0 commit comments

Comments
 (0)