Skip to content

Commit 36a9abf

Browse files
committed
Update README.md and example notebooks
1 parent c9284c6 commit 36a9abf

File tree

4 files changed

+116
-119
lines changed

4 files changed

+116
-119
lines changed

README.md

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,6 @@ The aim of this package is to provide real-time 3D visualization in Python for s
66
See [examples/kalinin2018.ipynb](examples/kalinin2018.ipynb) for an example.
77

88
[![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-
![Docker Image Version (latest semver)](https://img.shields.io/docker/v/kostrykin/carnapy?label=DockerHub%3A)
109
[![Anaconda-Server Badge](https://img.shields.io/badge/Install%20with-conda-%2387c305)](https://anaconda.org/kostrykin/carnapy)
1110
[![Anaconda-Server Badge](https://img.shields.io/conda/v/kostrykin/carnapy.svg?label=Version)](https://anaconda.org/kostrykin/carnapy)
1211
[![Anaconda-Server Badge](https://img.shields.io/conda/pn/kostrykin/carnapy.svg?label=Platforms)](https://anaconda.org/kostrykin/carnapy)
@@ -23,7 +22,7 @@ See [examples/kalinin2018.ipynb](examples/kalinin2018.ipynb) for an example.
2322
## 1. Limitations
2423

2524
* Only 8bit and 16bit volume data are supported at the moment.
26-
* DRR renderings are not exposed to Python yet.
25+
* Only a subset of rendering stages is exposed to Python yet.
2726
* Build process is currently limited to Linux-based systems.
2827

2928
---
@@ -33,7 +32,7 @@ Using the library requires the following dependencies:
3332
* [numpy](https://numpy.org/) ≥ 1.16
3433
* EGL driver support
3534
* OpenGL 3.3
36-
* Python ≥ 3.7
35+
* Python ≥ 3.9
3736

3837
The following dependencies must be satisfied for the build process:
3938
* [LibCarna](https://github.com/kostrykin/LibCarna) ≥ 3.4
@@ -42,9 +41,7 @@ The following dependencies must be satisfied for the build process:
4241
* [pybind11](https://github.com/pybind/pybind11)
4342
* EGL development files
4443

45-
In addition, the following dependencies are required to run the test suite:
46-
* [matplotlib](https://matplotlib.org/)
47-
* [scipy](https://www.scipy.org/)
44+
See environment.yml for further dependencies for testing and running.
4845

4946
---
5047
## 3. Installation

examples/cells.ipynb

Lines changed: 45 additions & 45 deletions
Large diffs are not rendered by default.

examples/cthead.ipynb

Lines changed: 33 additions & 33 deletions
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)