Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
alanocallaghan authored Oct 10, 2024
1 parent fad10bf commit e10cae3
Showing 1 changed file with 12 additions and 4 deletions.
16 changes: 12 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ By using the same custom fields for things like measurements and classifications

## Getting started

You can find the documentation on https://qupath.github.io/qubalab/.
You can find the documentation on https://qupath.github.io/qubalab-docs/.

This project contains the QuBaLab package in the `qubalab` folder. Take a look at the *Installation* section to install it.

Expand All @@ -33,10 +33,18 @@ If you just want to go through them, look at the [documentation](https://qupath.

## Installation

TODO when available on PyPI
QuBaLab will live on PyPI soon, but for the time being you should install it from
GitHub. You can do this directly using:

Installing the package through PyPI will only give access to the Python library. If you want to run the notebooks or
contribute to this project, take a look at the *Development* section.
```bash
pip install --upgrade https://github.com/qupath/qubalab/tarball/main
```

or if you have git installed:

```bash
pip install git+https://github.com/qupath/qubalab.git
```

## Development

Expand Down

0 comments on commit e10cae3

Please sign in to comment.