Metadata-Version: 2.1
Name: CarnaPy
Version: 0.0.10
Summary: General-purpose real-time 3D visualization
Home-page: http://evoid.de
Author: Leonid Kostrykin
Author-email: leonid.kostrykin@bioquant.uni-heidelberg.de
License: MIT
Description: CarnaPy
        ========
        
        The aim of this package is to provide general-purpose real-time 3D visualization for specifically, but not limited to, biomedical data, using Python. The library is based on [Carna](https://github.com/RWTHmediTEC/Carna).
        
        See [examples/kalinin2018.ipynb](examples/kalinin2018.ipynb) for an example.
        
        ---
        ## Contents
        
        * [Limitations](#1-limitations)
        * [Dependencies](#2-dependencies)
        * [Build instructions](#3-build-instructions)
         
        ---
        ## 1. Limitations
        
        * Only 12bit volume data is supported at the moment. Extension to 16bit or beyond should be straight-forward.
        * DRR renderings are not exposed to Python yet.
        
        ---
        ## 2. Dependencies
        
        The following dependencies must be satisfied for the build process:
        
        * [Eigen](http://eigen.tuxfamily.org/) ≥ 3.0.5
        * [Carna](https://github.com/RWTHmediTEC/Carna)
        * [libboost-iostreams](https://www.boost.org/doc/libs/1_76_0/libs/iostreams/doc/index.html)
        * OpenGL 3.3
        * GLEW ≥ 1.7
        * EGL
        * Python 3
        * [pybind11](https://github.com/pybind/pybind11)
        * Linux environment and Conda
        
        The build process has been tested with following tools and versions:
        
        * **Eigen 3.2.10** is known to be fully supported.
        * **GCC 7.5** is known to be fully supported.
        * **Python 3.8.5** is known to be fully supported.
        * **Ubuntu 18.04** is known to be fully supported.
        * **pybind11 2.5.0** is known to be fully supported.
        
        ---
        ## 3. Build instructions
        
        Assuming you are using a recent version of Ubuntu:
        
        ```bash
        sudo apt-get -qq install libglew-dev libegl1-mesa-dev libboost-iostreams-dev
        ```
        
        Create and activate a Conda environment to work in, then:
        
        ```bash
        conda install -c conda-forge pybind11
        ```
        
        Download a recent version of [Eigen](http://eigen.tuxfamily.org), unpack it, and tell CMake where it is located:
        
        ```bash
        wget https://gitlab.com/libeigen/eigen/-/archive/3.2.10/eigen-3.2.10.tar.gz
        tar -vzxf eigen-3.2.10.tar.gz -C /tmp/
        export CMAKE_PREFIX_PATH="/tmp/eigen-3.2.10:$CMAKE_PREFIX_PATH"
        ```
        
        If you have not already, download, build, and install Carna:
        
        ```bash
        cd /tmp
        git clone git@github.com:RWTHmediTEC/Carna.git
        cd Carna
        sh linux_build.sh
        ```
        
        Now it is time to build, package, and install CarnaPy:
        ```
        cd /tmp/CarnaPy
        python setup.py bdist_wheel
        python -m pip install CarnaPy/dist/CarnaPy-*.whl
        ```
        
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: GPU
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: POSIX :: Linux
Classifier: Programming Language :: C++
Classifier: Programming Language :: Python
Classifier: Topic :: Education
Classifier: Topic :: Multimedia :: Graphics :: 3D Rendering
Classifier: Topic :: Scientific/Engineering :: Visualization
Classifier: Topic :: Software Development :: User Interfaces
Description-Content-Type: text/markdown
