|
1 | 1 | # Slicer Core |
2 | 2 |
|
3 | | -SlicerCore, formally known as "VTK MRML", is an alternative build-system for the 3DSlicer project. |
| 3 | +SlicerCore is an alternative build-system for the 3DSlicer project. |
4 | 4 | It is intended to build a Python Package (wheel) from the core libraries and loadables modules of 3DSlicer. |
5 | 5 |
|
| 6 | +## About Slicer |
| 7 | + |
| 8 | +Slicer, or 3D Slicer, is a free, open source software package for visualization and image analysis. |
| 9 | + |
| 10 | +3D Slicer is natively designed to be available on multiple platforms, including Windows, Linux and macOS. |
| 11 | + |
| 12 | +For 3DSlicer community announcements and support, visit: |
| 13 | + |
| 14 | + https://discourse.slicer.org |
| 15 | + |
| 16 | +For documentation, tutorials, and more information, please see: |
| 17 | + |
| 18 | + https://www.slicer.org |
| 19 | + |
| 20 | +For 3DSlicer source code, please see: |
| 21 | + |
| 22 | + https://github.com/Slicer/Slicer |
| 23 | + |
| 24 | + |
| 25 | +## About Slicer Core |
| 26 | + |
| 27 | +Slicer Core in a single sentence: |
| 28 | +***Slicer Core is the Python package consisting of all 3DSlicer modules that do not depend on Qt.*** |
| 29 | + |
| 30 | +Slicer Core contains the following libraries of 3DSlicer: |
| 31 | +- `Base/Logic` |
| 32 | +- `Libs/*` |
| 33 | +- `Modules/Loadables/[MRML|MRMLDM|Logic|VTKWidgets]` |
| 34 | + |
| 35 | +This enables using 3DSlicer powerful MRML nodes system and associated medical-oriented algorithms in pure Python. |
| 36 | + |
| 37 | +## Using Slicer Core |
| 38 | + |
| 39 | +SlicerCore provides access to the main Slicer libraries through the slicer package namespace : |
| 40 | + |
| 41 | +```py |
| 42 | +from slicer import vtkMRMLScalarVolumeNode |
| 43 | +volume_node = vtkMRMLScalarVolumeNode() |
| 44 | +``` |
| 45 | + |
| 46 | +Although the library can be used as is, additional convenience classes are provided in the trame-slicer Python package to initialize application logic and scene, wrap 2D and 3D views, provide applications on the web and more. |
| 47 | + |
| 48 | +For more examples, please visit the **[trame-slicer](https://github.com/KitwareMedical/trame-slicer)** project. |
| 49 | + |
6 | 50 | ## Documentation and Examples |
7 | 51 |
|
8 | | -- **[3DSlicer API documentation](https://apidocs.slicer.org/main/index.html)** |
9 | | -- **[trame-slicer](https://github.com/KitwareMedical/trame-slicer)**: slicer-core usage example. |
| 52 | +- **[3DSlicer Developper Guide](https://slicer.readthedocs.io/en/latest/developer_guide/index.html)** |
| 53 | + - Note that only some parts of the developper guide applies to Slicer Core as some modules and classes are not available. |
| 54 | +- **[3DSlicer API Documentation](https://apidocs.slicer.org/main/index.html)** |
| 55 | +- **[Trame Slicer](https://github.com/KitwareMedical/trame-slicer)** |
10 | 56 |
|
11 | 57 | ## Acknowledgments |
12 | 58 |
|
|
0 commit comments