Skip to content

Installation

Prerequisites

Before installing the AP3 SDK, ensure you have:

  • Python ≥ 3.13, < 3.14
  • pip (Python package installer)
  • Virtual environment (recommended)

Installation Methods

If you received a wheel file from Silence Laboratories:

# Install directly from the wheel
pip install ap3-0.1.0-py3-none-any.whl

# Verify installation
python -c "import ap3; print('✅ AP3 SDK installed successfully!')"

Method 2: Development Installation

For development or contributing to AP3:

# Clone the repository (if you have access)
git clone https://github.com/silence-laboratories/ap3.git
cd ap3

# Create virtual environment
python -m venv .venv
source .venv/bin/activate  # On Windows: .venv\Scripts\activate

# Install in editable mode
pip install -e .

Verify Installation

After installation, verify that AP3 is correctly installed:

import ap3

print(f"AP3 SDK version: {ap3.__version__}")
print("✅ All core modules imported successfully!")

Platform-Specific Notes

macOS (Apple Silicon / Intel)

The SDK includes native binaries for both architectures. No additional configuration needed.

Linux (x86_64)

The SDK includes pre-compiled binaries. Ensure you have:

# Required system libraries
sudo apt-get install libssl-dev  # Debian/Ubuntu
sudo yum install openssl-devel   # RHEL/CentOS

Windows

Windows support is in development. Contact info@silencelaboratories.com for early access.

Updating

To update to a newer version:

# From wheel file
pip install --upgrade ap3-0.2.0-py3-none-any.whl

# From development
cd ap3
git pull
pip install -e . --upgrade

Uninstallation

To remove the AP3 SDK:

pip uninstall ap3

Troubleshooting Installation

Import Error: No module named 'ap3'

Solution: Ensure you're using the correct Python environment:

# Check Python version
python --version  # Should be 3.13.x

# Check if ap3 is installed
pip list | grep ap3

Binary Loading Error

If you see errors about missing .dylib or .so files:

Solution: Verify the binaries are included:

python -c "from pathlib import Path; import ap3; print(Path(ap3.__file__).parent / 'operations/psi/binaries')"

Permission Denied

If you get permission errors during installation:

Solution: Use a virtual environment (recommended) or user installation:

pip install --user ap3-0.1.0-py3-none-any.whl

Support

If you encounter issues: