Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/kitwaremedical/trame-slicer

Bring the capabilities of 3D Slicer to the web with modern UI using the trame framework!
https://github.com/kitwaremedical/trame-slicer

3d-slicer medical-imaging trame vue

Last synced: about 10 hours ago
JSON representation

Bring the capabilities of 3D Slicer to the web with modern UI using the trame framework!

Awesome Lists containing this project

README 

        
============

trame-slicer

============



.. image:: https://raw.githubusercontent.com/KitwareMedical/trame-slicer/main/docs/trame-slicer-medical-app-example.png

  :alt: Welcome to trame-slicer



trame-slicer is a Python library bringing `3D Slicer `_ components in trame as a

composable library.



It uses 3D Slicer's python wrapping and adds a thin wrapping to make it available with the

`trame framework `_.



Warning

-------



As the 3D Slicer Python wheel is not yet generated by the 3D Slicer CI, manually generated

wheels are provided for Python 3.10 for Windows and Linux WSL.



The API has not been stabilized / reviewed by the 3D Slicer core developers so please use

this library with caution.



Installing

----------



The library can be installed as follows :



* Setup a Python 3.10 environment

* Activate your environment

* Git clone the library

* cd into the library

* Use the `pip install -e . command` to install the library along it's dependencies

* Copy the vtk_mrml wheel file matching your OS

* Pip install the wheel using the find links command (see below)



.. code-block:: console



    pip install -e .

    pip install vtk_mrml-9.4.0-cp310-cp310-win_amd64.whl  --find-links . # Windows

    pip install vtk_mrml-9.4.0-cp310-cp310-manylinux_2_35_x86_64.whl  --find-links . # Linux WSL



Getting started

---------------



To get started using trame, please have a look at the

`introductory trame course `_.



To start using the trame-slicer library, have a look and run the `medical viewer app `_



Features

--------



The following subset of 3D Slicer features are currently supported :



* (limited) file loading

* Volume files (DCM, NRRD, NIFTI, ...)

* Model files (STL, OBJ)

* MRML / MRB files

* Segmentations (NRRD, NIFTI, ...)

* Display

    * 2D/3D with 3D Slicer UI manipulation

    * Volume Rendering preset / shift

* Bare bone access to 3D Slicer MRML scene and Core logic components



Work in progress

----------------



To make it easier for users to use trame-slicer, the following work are in progress :



* Slicer wheel generation merge into 3D Slicer's preview release

* CI changes to build the Slicer wheel along 3D Slicer's release

* 3D Slicer extension to install trame-slicer and launch a trame-slicer server directly from 3D Slicer



Contributing

------------



Contributions are welcomed, please follow the `CONTRIBUTING.rst <.CONTRIBUTING.rst/>`_ file for more information.



License

-------



The library is distributed with a permissive license.

Please look at the `LICENSE <.LICENSE/>`_ file for more information.



Acknowledgment

--------------



This library was funded by the following projects :



* `Cure Overgrowth Syndromes (COSY) RHU Project `_.

* `Handling heterogeneous Imaging and signal data for analysing the Neurodevelopmental Trajectories of premature newborns (HINT) ANR project `_



This library was created from the `trame-cookicutter `_ library.



Contact

-------



If you are interested in learning how you can use trame-slicer for your use case in the near future, or want to get

an early start using the framework, don't hesitate to `contact us `_. or reach out

in the `issue tracker `_ and

`3D Slicer discourse community `_.