Installation

Requirements

  • Python >= 3.10

  • C++ compiler with C++17 support (GCC >= 7, Clang >= 5, MSVC >= 2017)

  • NumPy >= 1.22

Build-time only (installed automatically):

  • pybind11 == 2.13

From source

git clone https://github.com/samuelmurail/pdb_cpp.git
cd pdb_cpp
pip install .

Development install

For active development with editable installs:

pip install -r requirements.txt   # build dependencies
pip install -e .                   # editable install

After changing C++ code, rebuild the extension:

pip install -e . --no-build-isolation

Verify the installation

python -c "from pdb_cpp import Coor; print('pdb_cpp imported successfully')"

Run the test suite

pip install pytest
pytest

Platform notes

Linux

A C++ compiler is usually pre-installed. If not:

sudo apt-get install g++    # Debian/Ubuntu
sudo dnf install gcc-c++    # Fedora

macOS

The Xcode command-line tools provide clang++:

xcode-select --install

Windows

Install the Visual Studio Build Tools and select the “C++ build tools” workload.