Skip to content

Commit 22daa6a

Browse files
committed
Update README.md
1 parent 137a10c commit 22daa6a

1 file changed

Lines changed: 14 additions & 18 deletions

File tree

README.md

Lines changed: 14 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,12 @@ LibCarna-Python
33

44
The aim of this package is to provide real-time 3D visualization in Python for specifically, but not limited to, biomedical data. The library is based on [LibCarna](https://github.com/kostrykin/LibCarna).
55

6-
See [examples/kalinin2018.ipynb](examples/kalinin2018.ipynb) for an example.
6+
See [libcarna.readthedocs.io](https://libcarna.readthedocs.io) for examples and documentation.
77

8-
[![Build LibCarnaPy and Docker image](https://github.com/kostrykin/LibCarnaPy/actions/workflows/build.yml/badge.svg)](https://github.com/kostrykin/LibCarnaPy/actions/workflows/build.yml)
9-
[![Anaconda-Server Badge](https://img.shields.io/badge/Install%20with-conda-%2387c305)](https://anaconda.org/kostrykin/carnapy)
10-
[![Anaconda-Server Badge](https://img.shields.io/conda/v/kostrykin/carnapy.svg?label=Version)](https://anaconda.org/kostrykin/carnapy)
11-
[![Anaconda-Server Badge](https://img.shields.io/conda/pn/kostrykin/carnapy.svg?label=Platforms)](https://anaconda.org/kostrykin/carnapy)
8+
[![Build and Test](https://github.com/kostrykin/LibCarna-Python/actions/workflows/build_all.yml/badge.svg)](https://github.com/kostrykin/LibCarna-Python/actions/workflows/build_all.yml)
9+
[![Anaconda-Server Badge](https://img.shields.io/badge/Install%20with-conda-%2387c305)](https://anaconda.org/bioconda/libcarna-python)
10+
[![Anaconda-Server Badge](https://img.shields.io/conda/v/bioconda/libcarna-python.svg?label=Version)](https://anaconda.org/bioconda/libcarna-python)
11+
[![Anaconda-Server Badge](https://img.shields.io/conda/pn/bioconda/libcarna-python.svg?label=Platforms)](https://anaconda.org/bioconda/libcarna-python)
1212

1313
---
1414
## Contents
@@ -28,19 +28,8 @@ See [examples/kalinin2018.ipynb](examples/kalinin2018.ipynb) for an example.
2828
---
2929
## 2. Dependencies
3030

31-
Using the library requires the following dependencies:
32-
* [numpy](https://numpy.org/) ≥ 1.16
33-
* EGL driver support
34-
* OpenGL 3.3
35-
* Python ≥ 3.10
36-
37-
The following dependencies must be satisfied for the build process:
38-
* [LibCarna](https://github.com/kostrykin/LibCarna) ≥ 3.4
39-
* [Eigen](http://eigen.tuxfamily.org/) ≥ 3.0.5
40-
* [pybind11](https://github.com/pybind/pybind11)
41-
* EGL development files
42-
43-
See environment.yml for further dependencies for testing and running.
31+
General dependencies are listed in environment.yml. Further dependencies for testing are listed in
32+
test/requirements.txt, and those for the documentation in docs/requirements.txt.
4433

4534
---
4635
## 3. Installation
@@ -51,6 +40,13 @@ The easiest way to install and use the library is to use one of the binary [Cond
5140
conda install bioconda::libcarna-python
5241
```
5342

43+
If you encounter an error that looks like this,
44+
45+
> Failed expression: pimpl->eglDpy != EGL_NO_DISPLAY
46+
47+
then you must install the EGL implementation suitable for your rendering hardware (e.g., `sudo apt install libegl1`
48+
which is a meta package that will automatically choose the right package, or `libegl-mesa0` for software rendering).
49+
5450
---
5551
## 4. Build instructions
5652

0 commit comments

Comments
 (0)