Skip to content

Commit 47b38cb

Browse files
committed
Update DOC
1 parent 1fbf058 commit 47b38cb

File tree

2 files changed

+11
-5
lines changed

2 files changed

+11
-5
lines changed

README.md

Lines changed: 10 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -20,22 +20,28 @@ Some details about the implementation can be found in my [thesis](https://doi.or
2020
It's easiest to start with something like [Anaconda](https://www.anaconda.com/distribution/) as a Python distribution.
2121
You'll need Python >= 3.6 .
2222

23-
You can simply install via pip:
23+
You can simply install the latest release with pip:
2424
`pip install spaudiopy`
2525

26-
Or if you want to go into detail and install from source:
26+
This also works for the latest [commit](https://github.com/chris-hld/spaudiopy/):
27+
`pip install git+https://github.com/chris-hld/spaudiopy.git@master`
28+
29+
### From Source
30+
31+
Alternatively, if you want to go into detail and install the package from source:
2732

2833
1. Create a conda environment, called e.g. 'spaudio':
29-
`conda create --name spaudio python=3.6 anaconda portaudio`
34+
`conda create --name spaudio python=3.8 anaconda portaudio`
3035
2. Activate this new environment:
3136
`conda activate spaudio`
3237

33-
Get the latest source code from GitHub:
38+
Get the latest source code from GitHub:
3439
`git clone https://github.com/chris-hld/spaudiopy.git && cd spaudiopy`
3540

3641
Install the package and remaining dependencies:
3742
`pip install -e . `
3843

44+
3945
## Contributions
4046

4147
This is meant to be an open project and contributions or feature requests are always welcome!

spaudiopy/sph.py

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -455,7 +455,7 @@ def max_rE_weights(N):
455455
456456
See Also
457457
--------
458-
:py:func:`spaudiopy.process.unity_gain` : Unit amplitude compensation.
458+
:py:func:`spaudiopy.sph.unity_gain` : Unit amplitude compensation.
459459
460460
References
461461
----------

0 commit comments

Comments
 (0)