diff --git a/README.md b/README.md index c0c0b9c..6f92c5c 100644 --- a/README.md +++ b/README.md @@ -1,4 +1,5 @@ -# Library for Acoustic Signal Processing +Library for Acoustic Signal Processing +====================================== Welcome to LASP: Library for Acoustic Signal Processing. LASP is a C++ library @@ -45,17 +46,14 @@ If you have any question(s), please feel free to contact us: [email](info@ascee. # Installation - Linux (Ubuntu-based) -## From wheel (recommended for non-developers) - -### Prerequisites +## Prerequisites Run the following on the command line to install all prerequisites on Debian-based Linux: -- `sudo apt install python3-pip libfftw3-3 libopenblas-base libusb-1.0-0 - libpulse0` +- `sudo apt install python3-pip libfftw3-3 libopenblas-base libusb-1.0-0 libpulse0` -### Download and install LASP +## Installation from wheel (recommended for non-developers) Go to: [LASP releases](https://code.ascee.nl/ASCEE/lasp/releases/latest/) and download the latest `.whl`. Then run: @@ -84,35 +82,43 @@ If building RtAudio with the Jack Audio Connection Kit (JACK) backend, you will - `$ cd lasp` - `pip install -e .` -# Installation - (x86_64) Windows (with WinPython), build with MSYS2 (NOT YET UPDATED!!) +# Installation - (x86_64) Windows (with WinPython), build with MSYS2 ## Prerequisites - Download and install [WinPython](https://winpython.github.io) + +## From wheel + +- Download latest wheel from [LASP releases](https://code.ascee.nl/ASCEE/lasp/releases/latest/) and +download the latest `.whl`. Then install with `pip`. + +## From source + - Download and install [MSYS2](https://msys2.org). Make sure to install the x86_64 version. -- Download and install [Git for Windows](https://git-scm.com) - - When unzipping WinPython, make sure to choose a proper and simple path, i.e. C:\winpython -- Append C:\winpython\ to the PATH environment variable. -- Run Python and install Pybind11 - - `python -m pip install pybind11` - - -- Open a msys2 **MINGW64** terminal. And run: - - - `pacman -S git` - -- Then clone the LASP repo: - - - `git clone https://code.ascee.nl/ascee/lasp` - - `cd lasp` - -- Configure MSYS2 further, and run cmake: - - - `scripts/install_msys2_buiddeps.sh` - - `scripts/configur_cmake_msys2.sh` +- Download and install [Git for Windows](https://git-scm.com) +- Open an MSYS2 **MINGW64** terminal, and install some tools we require: + - `$ pacman -S git` +- Create a new virtualenv: + - `$ /c/winpython//python.exe -m venv venv` +- Add the venv-python to the path (eases a lot of commands) + - `$ export PATH=$PATH:~/venv/Scripts` +- Install `build`: + - `$ pip install build` +- Clone LASP: + - `$ git clone --recurse-submodules https://code.ascee.nl/ascee/lasp && cd lasp` +- If run for the first time, we have to install the libraries we depend on in + MSYS2 (this only has to be done on a fresh MSYS2 installation): + - `$ scripts/install_msys2_builddeps.sh` +- Copy over required DLL's to be included in distribution: + - `scripts/copy_windows_dlls.sh` +- And... build! + - `pyproject-build` +- Lastly: the generated wheel can be installed in the current virtualenv: + - `pip install dist/lasp*.whl` # Documentation @@ -121,7 +127,7 @@ If building RtAudio with the Jack Audio Connection Kit (JACK) backend, you will [Online LASP documentation](https://lasp.ascee.nl/). -## In directory +## In directory (Linux/Debian) `$ sudo apt install doxygen graphviz` `$ pip install doxypypy` diff --git a/third_party/portaudio b/third_party/portaudio index daaf637..88ab584 160000 --- a/third_party/portaudio +++ b/third_party/portaudio @@ -1 +1 @@ -Subproject commit daaf637f6f9fce670031221abfd7dfde92e5cce3 +Subproject commit 88ab584e7bf4358599744cd662cfbc978f41efbf