Skip to content

trimming readme #89

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
ShantanuKodgirwar merged 1 commit into from
Jul 29, 2026
Merged

trimming readme #89

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
29 changes: 5 additions & 24 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,58 +42,39 @@ Install from PyPI within your virtual environment:
```bash
pip install ptylab
```

> [!NOTE]
> For much faster installs, we recommend [uv](https://docs.astral.sh/uv/getting-started/installation/): `uv pip install ptylab`
For much faster installs, we recommend [uv](https://docs.astral.sh/uv/getting-started/installation/): `uv pip install ptylab`

This package uses `cupy` to utilize GPU for faster reconstruction. To enable GPU support:

```bash
pip install "ptylab[gpu]"
```
You can check if GPU is detected with `ptylab check gpu`.

For the latest unreleased changes on `main`:

```bash
pip install git+https://github.com/PtyLab/PtyLab.py.git
```

Check GPU detection:

```bash
ptylab check gpu
```

### Development

Clone the repo and install dev dependencies with [uv](https://docs.astral.sh/uv/getting-started/installation/):
Clone the repo and install dev and gpu dependencies with [uv](https://docs.astral.sh/uv/getting-started/installation/):

```bash
git clone git@github.com:PtyLab/PtyLab.py.git
cd PtyLab.py
uv sync --extra dev
uv sync --extra dev,gpu # remove the GPU flag if you are on CPU
```

This creates a `.venv` virtual environment in the project root. Select this environment from your IDE.

To use the GPU as well, install with the `gpu` flag:

```bash
uv sync --extra dev,gpu
```

and check if GPU is detected with `uv run ptylab check gpu`.

Add tests for new behaviour and run the suite:
Add tests for new implementations and run the suite:

```bash
uv run pytest tests
```

CI runs this on every PR. Please bump the package version when modifying dependencies.

Releases are published to PyPI automatically: bump `version` in `pyproject.toml`, then publish a GitHub Release tagged `v<version>`.

## Citation

If you use this package, please cite:
Expand Down