Installation Instructions for Serval

WIP: Currently sparsley documented and lacking features.

Release

Clone the repo into the local directory and then install with:

pip install .

For development it is recommended to do:

pip install -e '.[all]'

Testing

The currently limited tests can be run with

pytest .

Note that this requires installation with testing or all dependency tag.

Troubleshooting

For MacOS: Serval cannot be compiled with the clang compiler that is the default for MacOS because it does not support OpenMP. You need to install a GNU compiler. Find where your installation is and the gcc version and assign the CC and CXX compilers to the equivalent binaries. For example, if you are using Homebrew to install gcc-15 then export the following variables.

export CC=/opt/homebrew/bin/gcc-15
export CXX=/opt/homebrew/bin/g++-15