Update documentation

TomographicImaging · Oct 8, 2024 · 2c7843d · 2c7843d
1 parent f06514d
commit 2c7843d
Show file tree

Hide file tree

Showing 113 changed files with 640 additions and 542 deletions.
diff --git a/assets/css/atom.css.map b/assets/css/atom.css.map
diff --git a/assets/css/rss.css.map b/assets/css/rss.css.map
diff --git a/assets/css/styles_feeling_responsive.css.map b/assets/css/styles_feeling_responsive.css.map
diff --git a/nightly/.buildinfo b/nightly/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: 27ed49a45643994b619cf768b8fdfbfb
+config: 056c4b5e6f2ad018ebe27cef2b5201aa
 tags: d77d1c0d9ca2f4c8421862c7c5a0d620
diff --git a/nightly/.doctrees/demos/00_CIL_geometry.doctree b/nightly/.doctrees/demos/00_CIL_geometry.doctree
diff --git a/nightly/.doctrees/environment.pickle b/nightly/.doctrees/environment.pickle
diff --git a/nightly/.doctrees/nbsphinx/demos/00_CIL_geometry.ipynb b/nightly/.doctrees/nbsphinx/demos/00_CIL_geometry.ipynb
@@ -5,10 +5,10 @@
    "execution_count": 1,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-10-01T12:25:08.724160Z",
-     "iopub.status.busy": "2024-10-01T12:25:08.723624Z",
-     "iopub.status.idle": "2024-10-01T12:25:08.726855Z",
-     "shell.execute_reply": "2024-10-01T12:25:08.726508Z"
+     "iopub.execute_input": "2024-10-08T14:08:00.223431Z",
+     "iopub.status.busy": "2024-10-08T14:08:00.223265Z",
+     "iopub.status.idle": "2024-10-08T14:08:00.226338Z",
+     "shell.execute_reply": "2024-10-08T14:08:00.225978Z"
     }
    },
    "outputs": [],
@@ -142,10 +142,10 @@
    "execution_count": 2,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-10-01T12:25:08.728336Z",
-     "iopub.status.busy": "2024-10-01T12:25:08.728183Z",
-     "iopub.status.idle": "2024-10-01T12:25:10.315005Z",
-     "shell.execute_reply": "2024-10-01T12:25:10.314488Z"
+     "iopub.execute_input": "2024-10-08T14:08:00.227914Z",
+     "iopub.status.busy": "2024-10-08T14:08:00.227763Z",
+     "iopub.status.idle": "2024-10-08T14:08:01.054886Z",
+     "shell.execute_reply": "2024-10-08T14:08:01.054365Z"
     }
    },
    "outputs": [
@@ -209,10 +209,10 @@
    "execution_count": 3,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-10-01T12:25:10.344545Z",
-     "iopub.status.busy": "2024-10-01T12:25:10.344118Z",
-     "iopub.status.idle": "2024-10-01T12:25:10.575150Z",
-     "shell.execute_reply": "2024-10-01T12:25:10.574639Z"
+     "iopub.execute_input": "2024-10-08T14:08:01.084840Z",
+     "iopub.status.busy": "2024-10-08T14:08:01.084375Z",
+     "iopub.status.idle": "2024-10-08T14:08:01.318288Z",
+     "shell.execute_reply": "2024-10-08T14:08:01.317800Z"
     }
    },
    "outputs": [
@@ -229,7 +229,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7efd201a71a0>"
+       "<cil.utilities.display.show_geometry at 0x7f44a7e90890>"
       ]
      },
      "execution_count": 3,
@@ -271,10 +271,10 @@
    "execution_count": 4,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-10-01T12:25:10.576963Z",
-     "iopub.status.busy": "2024-10-01T12:25:10.576606Z",
-     "iopub.status.idle": "2024-10-01T12:25:10.765717Z",
-     "shell.execute_reply": "2024-10-01T12:25:10.765270Z"
+     "iopub.execute_input": "2024-10-08T14:08:01.320055Z",
+     "iopub.status.busy": "2024-10-08T14:08:01.319663Z",
+     "iopub.status.idle": "2024-10-08T14:08:01.515695Z",
+     "shell.execute_reply": "2024-10-08T14:08:01.515230Z"
     }
    },
    "outputs": [
@@ -291,7 +291,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7efd20033290>"
+       "<cil.utilities.display.show_geometry at 0x7f44a7d34bc0>"
       ]
      },
      "execution_count": 4,
@@ -333,10 +333,10 @@
    "execution_count": 5,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-10-01T12:25:10.767217Z",
-     "iopub.status.busy": "2024-10-01T12:25:10.767063Z",
-     "iopub.status.idle": "2024-10-01T12:25:10.984029Z",
-     "shell.execute_reply": "2024-10-01T12:25:10.983525Z"
+     "iopub.execute_input": "2024-10-08T14:08:01.517450Z",
+     "iopub.status.busy": "2024-10-08T14:08:01.517036Z",
+     "iopub.status.idle": "2024-10-08T14:08:01.740142Z",
+     "shell.execute_reply": "2024-10-08T14:08:01.739571Z"
     }
    },
    "outputs": [
@@ -353,7 +353,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7efd17fc2f60>"
+       "<cil.utilities.display.show_geometry at 0x7f44a796e090>"
       ]
      },
      "execution_count": 5,
@@ -394,10 +394,10 @@
    "execution_count": 6,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-10-01T12:25:10.985807Z",
-     "iopub.status.busy": "2024-10-01T12:25:10.985476Z",
-     "iopub.status.idle": "2024-10-01T12:25:11.177136Z",
-     "shell.execute_reply": "2024-10-01T12:25:11.176614Z"
+     "iopub.execute_input": "2024-10-08T14:08:01.741793Z",
+     "iopub.status.busy": "2024-10-08T14:08:01.741593Z",
+     "iopub.status.idle": "2024-10-08T14:08:01.939280Z",
+     "shell.execute_reply": "2024-10-08T14:08:01.938783Z"
     }
    },
    "outputs": [
@@ -414,7 +414,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7efd16d16f00>"
+       "<cil.utilities.display.show_geometry at 0x7f44a79e7680>"
       ]
      },
      "execution_count": 6,
@@ -447,10 +447,10 @@
    "execution_count": 7,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-10-01T12:25:11.178710Z",
-     "iopub.status.busy": "2024-10-01T12:25:11.178554Z",
-     "iopub.status.idle": "2024-10-01T12:25:11.407675Z",
-     "shell.execute_reply": "2024-10-01T12:25:11.407183Z"
+     "iopub.execute_input": "2024-10-08T14:08:01.941073Z",
+     "iopub.status.busy": "2024-10-08T14:08:01.940749Z",
+     "iopub.status.idle": "2024-10-08T14:08:02.169743Z",
+     "shell.execute_reply": "2024-10-08T14:08:02.169261Z"
     }
    },
    "outputs": [
@@ -467,7 +467,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7efd15b382f0>"
+       "<cil.utilities.display.show_geometry at 0x7f44a5b2a930>"
       ]
      },
      "execution_count": 7,
@@ -499,10 +499,10 @@
    "execution_count": 8,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-10-01T12:25:11.409266Z",
-     "iopub.status.busy": "2024-10-01T12:25:11.409093Z",
-     "iopub.status.idle": "2024-10-01T12:25:11.620441Z",
-     "shell.execute_reply": "2024-10-01T12:25:11.619886Z"
+     "iopub.execute_input": "2024-10-08T14:08:02.171506Z",
+     "iopub.status.busy": "2024-10-08T14:08:02.171093Z",
+     "iopub.status.idle": "2024-10-08T14:08:02.394524Z",
+     "shell.execute_reply": "2024-10-08T14:08:02.394062Z"
     }
    },
    "outputs": [
@@ -519,7 +519,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7efd20891850>"
+       "<cil.utilities.display.show_geometry at 0x7f44a7f3fda0>"
       ]
      },
      "execution_count": 8,
@@ -549,10 +549,10 @@
    "execution_count": 9,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-10-01T12:25:11.621993Z",
-     "iopub.status.busy": "2024-10-01T12:25:11.621805Z",
-     "iopub.status.idle": "2024-10-01T12:25:11.837823Z",
-     "shell.execute_reply": "2024-10-01T12:25:11.837299Z"
+     "iopub.execute_input": "2024-10-08T14:08:02.396186Z",
+     "iopub.status.busy": "2024-10-08T14:08:02.395913Z",
+     "iopub.status.idle": "2024-10-08T14:08:02.624633Z",
+     "shell.execute_reply": "2024-10-08T14:08:02.624115Z"
     }
    },
    "outputs": [
@@ -569,7 +569,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7efd17fc0d10>"
+       "<cil.utilities.display.show_geometry at 0x7f44a7f60230>"
       ]
      },
      "execution_count": 9,
@@ -638,10 +638,10 @@
    "execution_count": 10,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-10-01T12:25:11.839380Z",
-     "iopub.status.busy": "2024-10-01T12:25:11.839211Z",
-     "iopub.status.idle": "2024-10-01T12:25:11.843776Z",
-     "shell.execute_reply": "2024-10-01T12:25:11.843402Z"
+     "iopub.execute_input": "2024-10-08T14:08:02.626615Z",
+     "iopub.status.busy": "2024-10-08T14:08:02.626087Z",
+     "iopub.status.idle": "2024-10-08T14:08:02.630719Z",
+     "shell.execute_reply": "2024-10-08T14:08:02.630347Z"
     }
    },
    "outputs": [
@@ -711,10 +711,10 @@
    "execution_count": 11,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-10-01T12:25:11.845135Z",
-     "iopub.status.busy": "2024-10-01T12:25:11.844976Z",
-     "iopub.status.idle": "2024-10-01T12:25:12.503617Z",
-     "shell.execute_reply": "2024-10-01T12:25:12.503136Z"
+     "iopub.execute_input": "2024-10-08T14:08:02.632066Z",
+     "iopub.status.busy": "2024-10-08T14:08:02.631910Z",
+     "iopub.status.idle": "2024-10-08T14:08:03.295342Z",
+     "shell.execute_reply": "2024-10-08T14:08:03.294802Z"
     }
    },
    "outputs": [
@@ -772,7 +772,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7efd14bc7ef0>"
+       "<cil.utilities.display.show_geometry at 0x7f44a4b87c50>"
       ]
      },
      "execution_count": 11,
@@ -815,10 +815,10 @@
    "execution_count": 12,
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-10-01T12:25:12.505512Z",
-     "iopub.status.busy": "2024-10-01T12:25:12.505113Z",
-     "iopub.status.idle": "2024-10-01T12:25:12.507812Z",
-     "shell.execute_reply": "2024-10-01T12:25:12.507407Z"
+     "iopub.execute_input": "2024-10-08T14:08:03.296901Z",
+     "iopub.status.busy": "2024-10-08T14:08:03.296721Z",
+     "iopub.status.idle": "2024-10-08T14:08:03.299407Z",
+     "shell.execute_reply": "2024-10-08T14:08:03.299013Z"
     }
    },
    "outputs": [],
@@ -845,7 +845,7 @@
    "name": "python",
    "nbconvert_exporter": "python",
    "pygments_lexer": "ipython3",
-   "version": "3.12.6"
+   "version": "3.12.7"
   },
   "vscode": {
    "interpreter": {

diff --git a/nightly/.doctrees/optimisation.doctree b/nightly/.doctrees/optimisation.doctree
diff --git a/nightly/_modules/cil/framework/acquisition_data/index.html b/nightly/_modules/cil/framework/acquisition_data/index.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>cil.framework.acquisition_data &#8212; CIL 24.1.1.dev115+gb91c0ebd documentation</title>
+    <title>cil.framework.acquisition_data &#8212; CIL 24.1.1.dev116+g0181b3fd documentation</title>
 
 
 
@@ -39,7 +39,7 @@
   <link rel="preload" as="script" href="../../../../_static/scripts/bootstrap.js?digest=fd05d3ddc9a6e3fa7c66" />
 <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=fd05d3ddc9a6e3fa7c66" />
 
-    <script src="../../../../_static/documentation_options.js?v=721fc42c"></script>
+    <script src="../../../../_static/documentation_options.js?v=43cef8ff"></script>
     <script src="../../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -49,14 +49,14 @@
     <script>
         DOCUMENTATION_OPTIONS.theme_version = '0.16.0rc0';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = '/CIL/versions.json';
-        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '24.1.1.dev115+gb91c0ebd';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '24.1.1.dev116+g0181b3fd';
         DOCUMENTATION_OPTIONS.show_version_warning_banner = true;
         </script>
     <link rel="index" title="Index" href="../../../../genindex/" />
     <link rel="search" title="Search" href="../../../../search/" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-  <meta name="docsearch:version" content="24.1.1.dev115+gb91c0ebd" />
+  <meta name="docsearch:version" content="24.1.1.dev116+g0181b3fd" />
   </head>
 
 

diff --git a/nightly/_modules/cil/framework/acquisition_geometry/index.html b/nightly/_modules/cil/framework/acquisition_geometry/index.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>cil.framework.acquisition_geometry &#8212; CIL 24.1.1.dev115+gb91c0ebd documentation</title>
+    <title>cil.framework.acquisition_geometry &#8212; CIL 24.1.1.dev116+g0181b3fd documentation</title>
 
 
 
@@ -39,7 +39,7 @@
   <link rel="preload" as="script" href="../../../../_static/scripts/bootstrap.js?digest=fd05d3ddc9a6e3fa7c66" />
 <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=fd05d3ddc9a6e3fa7c66" />
 
-    <script src="../../../../_static/documentation_options.js?v=721fc42c"></script>
+    <script src="../../../../_static/documentation_options.js?v=43cef8ff"></script>
     <script src="../../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -49,14 +49,14 @@
     <script>
         DOCUMENTATION_OPTIONS.theme_version = '0.16.0rc0';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = '/CIL/versions.json';
-        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '24.1.1.dev115+gb91c0ebd';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '24.1.1.dev116+g0181b3fd';
         DOCUMENTATION_OPTIONS.show_version_warning_banner = true;
         </script>
     <link rel="index" title="Index" href="../../../../genindex/" />
     <link rel="search" title="Search" href="../../../../search/" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-  <meta name="docsearch:version" content="24.1.1.dev115+gb91c0ebd" />
+  <meta name="docsearch:version" content="24.1.1.dev116+g0181b3fd" />
   </head>
 
 

diff --git a/nightly/_modules/cil/framework/block/index.html b/nightly/_modules/cil/framework/block/index.html
@@ -7,7 +7,7 @@
   <head>
     <meta charset="utf-8" />
     <meta name="viewport" content="width=device-width, initial-scale=1.0" />
-    <title>cil.framework.block &#8212; CIL 24.1.1.dev115+gb91c0ebd documentation</title>
+    <title>cil.framework.block &#8212; CIL 24.1.1.dev116+g0181b3fd documentation</title>
 
 
 
@@ -39,7 +39,7 @@
   <link rel="preload" as="script" href="../../../../_static/scripts/bootstrap.js?digest=fd05d3ddc9a6e3fa7c66" />
 <link rel="preload" as="script" href="../../../../_static/scripts/pydata-sphinx-theme.js?digest=fd05d3ddc9a6e3fa7c66" />
 
-    <script src="../../../../_static/documentation_options.js?v=721fc42c"></script>
+    <script src="../../../../_static/documentation_options.js?v=43cef8ff"></script>
     <script src="../../../../_static/doctools.js?v=9a2dae69"></script>
     <script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
@@ -49,14 +49,14 @@
     <script>
         DOCUMENTATION_OPTIONS.theme_version = '0.16.0rc0';
         DOCUMENTATION_OPTIONS.theme_switcher_json_url = '/CIL/versions.json';
-        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '24.1.1.dev115+gb91c0ebd';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '24.1.1.dev116+g0181b3fd';
         DOCUMENTATION_OPTIONS.show_version_warning_banner = true;
         </script>
     <link rel="index" title="Index" href="../../../../genindex/" />
     <link rel="search" title="Search" href="../../../../search/" />
   <meta name="viewport" content="width=device-width, initial-scale=1"/>
   <meta name="docsearch:language" content="en"/>
-  <meta name="docsearch:version" content="24.1.1.dev115+gb91c0ebd" />
+  <meta name="docsearch:version" content="24.1.1.dev116+g0181b3fd" />
   </head>