Skip to content

update the readme for pip install #126

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
Sep 25, 2025
Merged

update the readme for pip install #126

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
339794b
update the readme for pip intall
LalehB Sep 25, 2025
ec4e5dd
Merge branch 'main' into zero-det
LalehB Sep 25, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -168,6 +168,11 @@ Here are some tips for improving performance:

This repository contains the C++ implementation of the Tesseract quantum error correction decoder, along with a Python wrapper. The Python wrapper/interface exposes the decoding algorithms and helper utilities, allowing Python users to leverage this high-performance decoding algorithm.

For installation:
```bash
pip install tesseract-decoder
```

The following example demonstrates how to create and use the Tesseract decoder using the Python interface.

```python
Expand Down