diff --git a/README.md b/README.md index f1527a9..8ea9db0 100644 --- a/README.md +++ b/README.md @@ -31,7 +31,7 @@ install a licensed SIMIND installation. ## Key Features - **Connector-first API** - `SimindPythonConnector` for direct SIMIND execution from Python - **Package Adaptors** - STIR/SIRF/PyTomography adaptors for reconstruction workflows -- **No reconstruction reimplementation** - Reconstruction stays inside target packages +- **Native reconstruction workflows** - Use STIR/SIRF/PyTomography reconstruction tools with generated SIMIND data - **Dual scoring support** - SCATTWIN and PENETRATE - **DICOM builders** - DICOM-driven setup utilities for scanner/input preparation - **Advanced Schneider2000 density conversion** - 44-segment HU-to-density mapping diff --git a/docs/backends.rst b/docs/backends.rst index db15a0a..6327edc 100644 --- a/docs/backends.rst +++ b/docs/backends.rst @@ -1,9 +1,8 @@ Backend and Adaptor Dependencies ================================ -The package uses connector-first execution: SIMIND execution is handled by -``SimindPythonConnector`` and adaptor classes layer package-specific object -conversion on top. +Use ``SimindPythonConnector`` for direct SIMIND execution from Python. Use an +adaptor when you want outputs returned as native STIR/SIRF/PyTomography types. Dependency Matrix ----------------- diff --git a/docs/changelog.rst b/docs/changelog.rst index fc92c16..f55d5c2 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -62,8 +62,8 @@ Changed through ``SimindPythonConnector`` and return native backend projection types. - ``PyTomographySimindAdaptor`` remains focused on SIMIND I/O adaptation and tensor conversion only. -- README and docs pages were rewritten to user-facing, connector-first - guidance. +- README and docs pages were rewritten with user-facing guidance for connector + and adaptor workflows. Fixed ~~~~~ diff --git a/docs/intro.rst b/docs/intro.rst index 74a6e55..a2c3fcc 100644 --- a/docs/intro.rst +++ b/docs/intro.rst @@ -23,8 +23,7 @@ In practice this means: - ``SirfSimindAdaptor`` bridges SIMIND outputs into SIRF-native objects. - ``PyTomographySimindAdaptor`` bridges SIMIND outputs into torch/PyTomography workflows. -Reconstruction algorithms are intentionally left to the target packages -(STIR, SIRF, PyTomography). The adaptor layer handles data conversion and -I/O boundaries, not reconstruction-method wrappers. +After generating projections with this package, run reconstruction directly in +STIR, SIRF, or PyTomography using each package's native reconstruction tools. For axis and geometry conventions across these ecosystems, see :doc:`geometry`. diff --git a/docs/usage.rst b/docs/usage.rst index 4b50bb6..f5fbab0 100644 --- a/docs/usage.rst +++ b/docs/usage.rst @@ -3,8 +3,8 @@ Usage Guide =========== -Connector-First Quick Start ---------------------------- +Quick Start +----------- Use ``SimindPythonConnector`` when you want direct Python control of SIMIND inputs/outputs without any reconstruction-package dependency.