File tree Expand file tree Collapse file tree 2 files changed +20
-1
lines changed Expand file tree Collapse file tree 2 files changed +20
-1
lines changed Original file line number Diff line number Diff line change @@ -4,6 +4,23 @@ libcarna-python
44These are the Python bindings for the LibCarna library. The documentation of the original LibCarna library can be found at:
55https://kostrykin.github.io/LibCarna/html.
66
7+
8+ Getting Started
9+ ---------------
10+
11+ The easiest way to install and use the library is to use our pre-built
12+ `Conda <https://www.anaconda.com/docs/getting-started/miniconda >`_ packages::
13+
14+ conda install bioconda::libcarna-python
15+
16+ To get started, it is best to consider our `Examples `_ below.
17+
18+ .. note ::
19+ If you encounter an error similar to `"Failed expression: pimpl->eglDpy != EGL_NO_DISPLAY" `, then you must install
20+ an EGL implementation suitable for your rendering hardware. For example, on Ubuntu Linux, ``sudo apt install
21+ libegl1 `` installs a meta package that automatically chooses the right implementation, or ``libegl-mesa0 `` for
22+ software rendering.
23+
724Examples
825--------
926
Original file line number Diff line number Diff line change @@ -16,13 +16,15 @@ conda activate "$ROOT"/.env
1616# Create build directory
1717mkdir -p " $ROOT " /build
1818
19- # Build native extension
19+ # Configure build
2020cd " $ROOT " /build
2121cmake -DCMAKE_BUILD_TYPE=Release \
2222 -DPYTHON_EXECUTABLE=" $( which python) " \
2323 -Dpybind11_DIR=" $CONDA_PREFIX /share/cmake/pybind11" \
2424 -DCMAKE_MODULE_PATH=" $CONDA_PREFIX /share/cmake/Modules" \
2525 " $ROOT "
26+
27+ # Build native extension
2628if [ -z " $LIBCARNA_SKIP_NATIVE " ]; then
2729 make VERBOSE=1
2830fi
You can’t perform that action at this time.
0 commit comments