Installation Guide

System Requirements

Before installing SpinQLab Link, make sure your system meets the following requirements:

Operating System Support

Windows 10/11
macOS 10.14+
Ubuntu 18.04+
CentOS 7+
Other major Linux distributions

Python Version

Python 3.8 or later
Python 3.9 or 3.10 is recommended

Dependencies

SpinQLab Link relies on the following Python libraries:

numpy >= 1.20.0
matplotlib >= 3.4.0
pydantic >= 2.0.0
protobuf >= 3.19.0
pyqtgraph (for data visualization)
scipy (for data analysis)

Installation Methods

Install from PyPI (recommended)

This is the easiest installation method and works for most users:

# Install using pip
pip install spinqlablink

Verify the Installation

After the installation is complete, you can verify that the installation was successful by:

# Import library
import spinqlablink

# Check version
print(f"SpinQLab Link version: {spinqlablink.__version__}")

# Test basic functionality
from spinqlablink import SpinQLabLink, ExperimentType, Pulse
print("All modules imported successfully!")

Common Issues

Installation Failed

If you encounter installation failures, try the following solutions:

Update pip:
```
pip install --upgrade pip
```
Clean up cache:
```
pip cache purge
```

Use domestic mirroring (China users):

pip install -i https://pypi.tuna.tsinghua.edu.cn/simple/ spinqlablink

permissions issues

You may encounter permissions issues on some systems:

# Linux/macOS: Use the --user option
pip install --user spinqlablink

# Or use sudo (not recommended)
sudo pip install spinqlablink

network problems

If you experience network connectivity issues:

Using proxy:

pip install --proxy http://proxy.company.com:port spinqlablink

Offline installation:

# Download wheel file
pip download spinqlablink

# Offline installation
pip install spinqlablink-*.whl

uninstall

To uninstall SpinQLab Link:

pip uninstall spinqlablink

next step

After the installation is complete, you can:

Read Quick Start Learn how to use it
Browse SpinQLab Link Package for complete API references

If you encounter any problems, please check Contact us for assistance.