Merge pull request #7 from lukepolson/development

update docs
PyTomography · Aug 3, 2024 · 46fa08d · 46fa08d
2 parents 31058b0 + ffbb2ec
commit 46fa08d
Show file tree

Hide file tree

Showing 12 changed files with 95 additions and 11 deletions.
diff --git a/docs/source/index.rst b/docs/source/index.rst
@@ -14,7 +14,7 @@ In traditional SPECT reconstruction, only the geometric component of the PSF is
     :gutter: 2
 
     .. grid-item-card:: Tutorials
-        :link: tutorials
+        :link: tutorials/tutorials
         :link-type: doc
         :link-alt: Tutorials
         :text-align: center
@@ -51,3 +51,9 @@ In traditional SPECT reconstruction, only the geometric component of the PSF is
             :color: warning
 
             **Ask questions on PyTomography discourse**
+
+.. toctree::
+   :maxdepth: 1
+   :hidden:
+
+   tutorials/tutorials
diff --git a/docs/source/tutorials/1_kernel1d_intro.ipynb b/docs/source/tutorials/1_kernel1d_intro.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Tutorial 1: Kernel1D"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,

diff --git a/docs/source/tutorials/2_kernel2d_intro.ipynb b/docs/source/tutorials/2_kernel2d_intro.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Tutorial 2: Kernel2D"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,

diff --git a/docs/source/tutorials/3_operators.ipynb b/docs/source/tutorials/3_operators.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Tutorial 3: Operators"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,

diff --git a/docs/source/tutorials/4_optimization_intro.ipynb b/docs/source/tutorials/4_optimization_intro.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Tutorial 4: Optimization Introduction"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,

diff --git a/docs/source/tutorials/5_optimization_ac225.ipynb b/docs/source/tutorials/5_optimization_ac225.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Tutorial 5: Ac225 Kernel Fitting"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},

diff --git a/docs/source/tutorials/6_nearestkernel_ac225.ipynb b/docs/source/tutorials/6_nearestkernel_ac225.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Tutorial 6: NearestKernel"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},

diff --git a/docs/source/tutorials/7_pytomography_ac225recon.ipynb b/docs/source/tutorials/7_pytomography_ac225recon.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Tutorial 7: Ac225 Reconstruction"
+   ]
+  },
   {
    "cell_type": "markdown",
    "metadata": {},

diff --git a/docs/source/tutorials/8_pytomography_lu177_le_recon.ipynb b/docs/source/tutorials/8_pytomography_lu177_le_recon.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Tutorial 8: Lu177 Low Energy Collimator Modeling"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,

diff --git a/docs/source/tutorials/9_lu177_me_modeling_and_recon.ipynb b/docs/source/tutorials/9_lu177_me_modeling_and_recon.ipynb
@@ -1,5 +1,12 @@
 {
  "cells": [
+  {
+   "cell_type": "markdown",
+   "metadata": {},
+   "source": [
+    "# Tutorial 9: Lu177 Medium Energy Collimator Modeling"
+   ]
+  },
   {
    "cell_type": "code",
    "execution_count": 1,

diff --git a/docs/source/tutorials.rst → docs/source/tutorials/tutorials.rst b/docs/source/tutorials.rst → docs/source/tutorials/tutorials.rst
@@ -9,73 +9,87 @@ The tutorials use data that can be downloaded `here <https://drive.google.com/dr
     :gutter: 2
 
     .. grid-item-card:: 1: Kernel1D
-        :link: tutorials/1_kernel1d_intro
+        :link: 1_kernel1d_intro
         :link-type: doc
         :link-alt: Tutorial 1
         :text-align: center
 
         :material-outlined:`psychology;4em;sd-text-secondary`
 
     .. grid-item-card:: 2: Kernel2D
-        :link: tutorials/2_kernel2d_intro
+        :link: 2_kernel2d_intro
         :link-type: doc
         :link-alt: Tutorial 2
         :text-align: center
 
         :material-outlined:`psychology;4em;sd-text-secondary`
 
     .. grid-item-card:: 3: Operators
-        :link: tutorials/3_operators
+        :link: 3_operators
         :link-type: doc
         :link-alt: Tutorial 3
         :text-align: center
 
         :material-outlined:`psychology;4em;sd-text-secondary`
 
     .. grid-item-card:: 4: Optimization Intro
-        :link: tutorials/4_optimization_intro
+        :link: 4_optimization_intro
         :link-type: doc
         :link-alt: Tutorial 4
         :text-align: center
 
         :material-outlined:`psychology;4em;sd-text-secondary`
 
     .. grid-item-card:: 5: Optimization Ac225
-        :link: tutorials/5_optimization_ac225
+        :link: 5_optimization_ac225
         :link-type: doc
         :link-alt: Tutorial 5
         :text-align: center
 
         :material-outlined:`psychology;4em;sd-text-secondary`
 
     .. grid-item-card:: 6: NearestKernel Ac225
-        :link: tutorials/6_nearestkernel_ac225
+        :link: 6_nearestkernel_ac225
         :link-type: doc
         :link-alt: Tutorial 6
         :text-align: center
 
         :material-outlined:`psychology;4em;sd-text-secondary`
 
     .. grid-item-card:: 7: Ac225 Reconstruction
-        :link: tutorials/7_pytomography_ac225_recon
+        :link: 7_pytomography_ac225recon
         :link-type: doc
         :link-alt: Tutorial 7
         :text-align: center
 
         :material-outlined:`psychology;4em;sd-text-secondary`
 
     .. grid-item-card:: 8: Lu177 Low Energy Collimator
-        :link: tutorials/8_pytomography_lu177_le_recon
+        :link: 8_pytomography_lu177_le_recon
         :link-type: doc
         :link-alt: Tutorial 8
         :text-align: center
 
         :material-outlined:`psychology;4em;sd-text-secondary`
 
     .. grid-item-card:: 9: Lu177 Medium Energy Collimator
-        :link: tutorials/9_lu177_me_modeling_and_recon
+        :link: 9_lu177_me_modeling_and_recon
         :link-type: doc
         :link-alt: Tutorial 9
         :text-align: center
 
         :material-outlined:`psychology;4em;sd-text-secondary`
+
+.. toctree::
+    :maxdepth: 1
+    :hidden:
+
+    1_kernel1d_intro
+    2_kernel2d_intro
+    3_operators
+    4_optimization_intro
+    5_optimization_ac225
+    6_nearestkernel_ac225
+    7_pytomography_ac225recon
+    8_pytomography_lu177_le_recon
+    9_lu177_me_modeling_and_recon
diff --git a/pyproject.toml b/pyproject.toml
@@ -43,6 +43,7 @@ doc = [
   "nbsphinx",
   "sphinx-autoapi~=3.0.0",
   "ipykernel",
-  "pydata-sphinx-theme"
+  "pydata-sphinx-theme",
+  "sphinx-design"
 ]