🚧 DEVELOPMENT STATUS: ALPHA - NOT READY FOR USE 🚧
⚠️ WARNING: This project is in early development and is NOT suitable for production use.
- API is unstable and subject to major changes
- Many features are incomplete or untested
- Documentation may be outdated or incorrect
- Breaking changes will occur without notice
- DO NOT USE in any production environment
This repository is shared for development purposes only. Check back later for stable releases.
A library for multi-dimensional signal processing.
- C Compiler: clang or gcc
- Build Tools: Make, flex, bison
- Documentation: Doxygen, Python 3 with
sphinxandbreathe
# Install LLVM and OpenMP for parallel processing
brew install llvm libomp
# Install BLAS/LAPACK (uses Accelerate framework by default)
# Install curl for dependency fetching
brew install curl
# For documentation
pip install -r docs/requirements.txt# Core build dependencies
sudo apt-get update
sudo apt-get install -y \
build-essential \
make \
flex \
bison \
curl
# OpenMP and math libraries
sudo apt-get install -y \
libomp-dev \
libopenblas-dev \
liblapacke-dev
# For dependency fetching
sudo apt-get install -y libcurl4-openssl-dev
# For documentation
pip install -r docs/requirements.txt# Install via MSYS2
pacman -S mingw-w64-x86_64-toolchain \
mingw-w64-x86_64-curl \
mingw-w64-x86_64-openblas \
mingw-w64-x86_64-lapack \
mingw-w64-x86_64-openmp \
make flex bisonmake clean
make allFor optimal performance on macOS, use LLVM clang with OpenMP:
export CC="/opt/homebrew/opt/llvm/bin/clang"
export LDFLAGS="-L/opt/homebrew/opt/libomp/lib -L/opt/homebrew/opt/llvm/lib"
export CPPFLAGS="-I/opt/homebrew/opt/libomp/include -I/opt/homebrew/opt/llvm/include"
make clean
make allmake all- Build library and fetch dependenciesmake libRMN.a- Static library onlymake install-shared- Build shared library (.dylib/.so/.dll)make fetchlibs- Download OCTypes and SITypes dependenciesmake clean- Remove build artifacts
Output: Produces libRMN.a (static) and optionally shared libraries in install/lib/.
RMNLib automatically downloads its dependencies (OCTypes and SITypes) from GitHub releases during the build process. The make fetchlibs target:
- Downloads
libOCTypes-{platform}.zipandlibOCTypes-headers.zip - Downloads
libSITypes-{platform}.zipandlibSITypes-headers.zip - Extracts libraries to
third_party/lib/ - Extracts headers to
third_party/include/
Note: Requires internet connection for initial build. Dependencies are cached in third_party/ for subsequent builds.
To build the API docs (after the library is built):
make docs # from project rootThe HTML output appears in docs/_build/html.
The latest documentation is hosted on Read the Docs: https://RMN.readthedocs.io/en/latest/
A Read the Docs configuration file (.readthedocs.yml) is included at the project root to automate the documentation build.
After building the library, run:
make test # build and run all tests
make test-debug # run under LLDB
make test-asan # with AddressSanitizerProblem: Build shows "OpenMP not found - using sequential processing"
Solution:
- macOS: Install LLVM and set compiler paths as shown above
- Linux: Install
libomp-devpackage - Windows: Install
mingw-w64-x86_64-openmppackage
Problem: "Cannot find zipfile directory" or download errors
Solutions:
- Check internet connection
- Verify OCTypes/SITypes releases are available on GitHub
- Try
make fetchlibsseparately beforemake all
Problem: Linker errors for BLAS/LAPACK functions
Solutions:
- macOS: Uses Accelerate framework (built-in)
- Linux: Install
libopenblas-dev liblapacke-dev - Windows: Install
mingw-w64-x86_64-openblas mingw-w64-x86_64-lapack
Problem: "flex: command not found" or "yacc: command not found"
Solutions:
- macOS:
brew install flex bison - Linux:
sudo apt-get install flex bison - Windows: Install via MSYS2 as shown above