Skip to content

Commit

Permalink
chore: update readme and link to docs (#115)
Browse files Browse the repository at this point in the history
  • Loading branch information
manzt authored Mar 15, 2023
1 parent d835eb3 commit 13b0a71
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# higlass-python v2 🔎
# higlass-python 🔎

a fresh python library for [`higlass`](https://github.com/higlass/higlass) built
on top of [`higlass-schema`](https://github.com/higlass/higlass-schema) and
Expand All @@ -9,6 +9,13 @@ on top of [`higlass-schema`](https://github.com/higlass/higlass-schema) and

## Usage

> **Note** A release candidate for `higlass-python` v1 is now available on
> PyPI and can be installed via pip:
```sh
pip install --pre higlass-python
```

```python
import higlass as hg

Expand Down Expand Up @@ -39,6 +46,9 @@ view_lock = hg.lock(view1, view2)

![Side-by-side Hi-C heatmaps, linked by pan and zoom](https://user-images.githubusercontent.com/24403730/159050305-e6a48f03-fba1-4ff7-8eee-2e9c5c40ef88.gif)


To learn more about the new API, check out the [updated documentation](https://higlass.io/higlass-python).

## Development

**higlass-python** uses [the recommended](https://packaging.python.org/en/latest/flow/#) `hatchling` build-system,
Expand Down

0 comments on commit 13b0a71

Please sign in to comment.