Skip to content

Commit

Permalink
Merge pull request #50 from lucas-diedrich/faq
Browse files Browse the repository at this point in the history
FAQ
  • Loading branch information
lucas-diedrich authored Jan 20, 2025
2 parents 3a1e78e + bcea9a2 commit 6bfb772
Showing 1 changed file with 5 additions and 16 deletions.
21 changes: 5 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ Read and write funtionalities from and to spatialdata for deep visual proteomics
## Getting started

Please refer to the [documentation][],
in particular, the [API documentation][].
in particular, the [API documentation][],
[tutorials][],
and the [FAQs][].

## Installation

Expand All @@ -39,21 +41,6 @@ conda create -n dvpio python=3.11 -y && conda activate dvpio
pip install git+https://github.com/lucas-diedrich/dvp-io.git@main
```

## Known issues with napari_spatialdata

Importing napari_spatialdata might initially fail due missing non-python dependencies. If you get the following error:

```python
import napari_spatialdata
> qtpy.PythonQtError: No Qt bindings could be found
```

Try to install the `pyqt5-tools` binaries in your environment

```bash
pip install pyqt5-tools
```

## Release notes

Refer to the [Releases page](https://github.com/lucas-diedrich/dvp-io/releases) for information on releases and the changelog.
Expand All @@ -71,4 +58,6 @@ Refer to the [Releases page](https://github.com/lucas-diedrich/dvp-io/releases)
[documentation]: https://dvp-io.readthedocs.io
[changelog]: https://dvp-io.readthedocs.io/en/latest/changelog.html
[api documentation]: https://dvp-io.readthedocs.io/en/latest/api.html
[FAQs]: https://dvp-io.readthedocs.io/en/latest/faq.html
[tutorials]: https://dvp-io.readthedocs.io/en/latest/tutorials.html
[pypi]: https://pypi.org/project/dvp-io

0 comments on commit 6bfb772

Please sign in to comment.