Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
chris-hld authored Jan 26, 2024
1 parent b0b1fd2 commit c1f49ed
Showing 1 changed file with 19 additions and 15 deletions.
34 changes: 19 additions & 15 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,30 +9,34 @@ So far, there are a bunch of functions exposed, please feel free to
add/contribute more if needed!


Prerequisites
Quickstart
---
1. Compile SAF, provided as a submodule, see instructions in its [docs](https://github.com/leomccormack/Spatial_Audio_Framework/blob/master/README.md)
2. Install numpy and CFFI, e.g. `conda install numpy cffi`
3. Now we need to build *safpy*, which creates the module.
Running `pip install -e .` builds it automatically
1. Clone SAFpy, SAF is provided as a submodule, and change to the folder

(you can also build manually, e.g., for debugging, with
`python safpy_build.py`)
```git clone --recursive https://github.com/chris-hld/SAFpy && cd SAFpy```

2. Go to the SAF folder and compile SAF, see instructions in its [docs](https://github.com/leomccormack/Spatial_Audio_Framework/blob/master/README.md).
For example with

```cmake -S . -B build -DSAF_PERFORMANCE_LIB=SAF_USE_OPEN_BLAS_AND_LAPACKE && cmake --build ./build```

3. Install numpy and CFFI (in the environment you want to use), e.g. `conda install numpy cffi`
4. Now we need to build *safpy*, which creates the module.
Running `pip install -e .` (with `.` in the SAFpy folder) builds it automatically and installs any potentially missing Python dependencies.
6. (Optional) Test if everything works, run `pytest -vvv` in the SAFpy folder.


Details
---
You can also build SAFpy manually, e.g., for debugging, with
`python safpy_build.py`.

By default, it assumes SAF in a subdirectory, which is obtained by `git submodule update --init --recursive `.
In case you want to use a different location, you can simply adapt the variable `saf_path` in `safpy_build.py` if needed.
There you also have access to change the SAF performance library options, in case the default is not working for you.

If in trouble you can have a look at the CI steps [here](https://github.com/chris-hld/SAFpy/blob/master/.github/workflows/python-safpy.yml).

Install
---
`pip install -e . `

Test
---
`pytest -vvv`

Usage
---
Use *safpy* as a python package.
Expand Down

0 comments on commit c1f49ed

Please sign in to comment.