Update documentation

TomographicImaging · Oct 10, 2024 · c831c17 · c831c17
1 parent 2c7843d
commit c831c17
Show file tree

Hide file tree

Showing 115 changed files with 739 additions and 723 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: 056c4b5e6f2ad018ebe27cef2b5201aa
+config: 9d113fe00c49b9273542b0af0299309f
 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-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"
+     "iopub.execute_input": "2024-10-10T15:00:47.139098Z",
+     "iopub.status.busy": "2024-10-10T15:00:47.138930Z",
+     "iopub.status.idle": "2024-10-10T15:00:47.141990Z",
+     "shell.execute_reply": "2024-10-10T15:00:47.141499Z"
     }
    },
    "outputs": [],
@@ -142,10 +142,10 @@
    "execution_count": 2,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-10-10T15:00:47.143656Z",
+     "iopub.status.busy": "2024-10-10T15:00:47.143344Z",
+     "iopub.status.idle": "2024-10-10T15:00:47.979036Z",
+     "shell.execute_reply": "2024-10-10T15:00:47.978514Z"
     }
    },
    "outputs": [
@@ -209,10 +209,10 @@
    "execution_count": 3,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-10-10T15:00:48.009760Z",
+     "iopub.status.busy": "2024-10-10T15:00:48.009282Z",
+     "iopub.status.idle": "2024-10-10T15:00:48.245699Z",
+     "shell.execute_reply": "2024-10-10T15:00:48.245198Z"
     }
    },
    "outputs": [
@@ -229,7 +229,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7f44a7e90890>"
+       "<cil.utilities.display.show_geometry at 0x7ff5dc425520>"
       ]
      },
      "execution_count": 3,
@@ -271,10 +271,10 @@
    "execution_count": 4,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-10-10T15:00:48.247290Z",
+     "iopub.status.busy": "2024-10-10T15:00:48.247102Z",
+     "iopub.status.idle": "2024-10-10T15:00:48.448491Z",
+     "shell.execute_reply": "2024-10-10T15:00:48.447866Z"
     }
    },
    "outputs": [
@@ -291,7 +291,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7f44a7d34bc0>"
+       "<cil.utilities.display.show_geometry at 0x7ff5dc1bff80>"
       ]
      },
      "execution_count": 4,
@@ -333,10 +333,10 @@
    "execution_count": 5,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-10-10T15:00:48.450349Z",
+     "iopub.status.busy": "2024-10-10T15:00:48.449986Z",
+     "iopub.status.idle": "2024-10-10T15:00:48.680159Z",
+     "shell.execute_reply": "2024-10-10T15:00:48.679642Z"
     }
    },
    "outputs": [
@@ -353,7 +353,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7f44a796e090>"
+       "<cil.utilities.display.show_geometry at 0x7ff5dc1beff0>"
       ]
      },
      "execution_count": 5,
@@ -394,10 +394,10 @@
    "execution_count": 6,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-10-10T15:00:48.681831Z",
+     "iopub.status.busy": "2024-10-10T15:00:48.681624Z",
+     "iopub.status.idle": "2024-10-10T15:00:48.874500Z",
+     "shell.execute_reply": "2024-10-10T15:00:48.873984Z"
     }
    },
    "outputs": [
@@ -414,7 +414,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7f44a79e7680>"
+       "<cil.utilities.display.show_geometry at 0x7ff5bcfb8fe0>"
       ]
      },
      "execution_count": 6,
@@ -447,10 +447,10 @@
    "execution_count": 7,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-10-10T15:00:48.876162Z",
+     "iopub.status.busy": "2024-10-10T15:00:48.875891Z",
+     "iopub.status.idle": "2024-10-10T15:00:49.111341Z",
+     "shell.execute_reply": "2024-10-10T15:00:49.110852Z"
     }
    },
    "outputs": [
@@ -467,7 +467,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7f44a5b2a930>"
+       "<cil.utilities.display.show_geometry at 0x7ff5bcfe3650>"
       ]
      },
      "execution_count": 7,
@@ -499,10 +499,10 @@
    "execution_count": 8,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-10-10T15:00:49.112876Z",
+     "iopub.status.busy": "2024-10-10T15:00:49.112707Z",
+     "iopub.status.idle": "2024-10-10T15:00:49.341722Z",
+     "shell.execute_reply": "2024-10-10T15:00:49.341192Z"
     }
    },
    "outputs": [
@@ -519,7 +519,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7f44a7f3fda0>"
+       "<cil.utilities.display.show_geometry at 0x7ff5bce9d250>"
       ]
      },
      "execution_count": 8,
@@ -549,10 +549,10 @@
    "execution_count": 9,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-10-10T15:00:49.343670Z",
+     "iopub.status.busy": "2024-10-10T15:00:49.343209Z",
+     "iopub.status.idle": "2024-10-10T15:00:49.573519Z",
+     "shell.execute_reply": "2024-10-10T15:00:49.573001Z"
     }
    },
    "outputs": [
@@ -569,7 +569,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7f44a7f60230>"
+       "<cil.utilities.display.show_geometry at 0x7ff5bcfe0380>"
       ]
      },
      "execution_count": 9,
@@ -638,10 +638,10 @@
    "execution_count": 10,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-10-10T15:00:49.575206Z",
+     "iopub.status.busy": "2024-10-10T15:00:49.574924Z",
+     "iopub.status.idle": "2024-10-10T15:00:49.579689Z",
+     "shell.execute_reply": "2024-10-10T15:00:49.579299Z"
     }
    },
    "outputs": [
@@ -711,10 +711,10 @@
    "execution_count": 11,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-10-10T15:00:49.581236Z",
+     "iopub.status.busy": "2024-10-10T15:00:49.580973Z",
+     "iopub.status.idle": "2024-10-10T15:00:50.254514Z",
+     "shell.execute_reply": "2024-10-10T15:00:50.253977Z"
     }
    },
    "outputs": [
@@ -772,7 +772,7 @@
     {
      "data": {
       "text/plain": [
-       "<cil.utilities.display.show_geometry at 0x7f44a4b87c50>"
+       "<cil.utilities.display.show_geometry at 0x7ff5dc12fdd0>"
       ]
      },
      "execution_count": 11,
@@ -815,10 +815,10 @@
    "execution_count": 12,
    "metadata": {
     "execution": {
-     "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"
+     "iopub.execute_input": "2024-10-10T15:00:50.256710Z",
+     "iopub.status.busy": "2024-10-10T15:00:50.256175Z",
+     "iopub.status.idle": "2024-10-10T15:00:50.259349Z",
+     "shell.execute_reply": "2024-10-10T15:00:50.258941Z"
     }
    },
    "outputs": [],

diff --git a/nightly/.doctrees/optimisation.doctree b/nightly/.doctrees/optimisation.doctree
diff --git a/nightly/.doctrees/processors.doctree b/nightly/.doctrees/processors.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.dev116+g0181b3fd documentation</title>
+    <title>cil.framework.acquisition_data &#8212; CIL 24.1.1.dev117+g2962b920 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=43cef8ff"></script>
+    <script src="../../../../_static/documentation_options.js?v=47389ba2"></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.dev116+g0181b3fd';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '24.1.1.dev117+g2962b920';
         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.dev116+g0181b3fd" />
+  <meta name="docsearch:version" content="24.1.1.dev117+g2962b920" />
   </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.dev116+g0181b3fd documentation</title>
+    <title>cil.framework.acquisition_geometry &#8212; CIL 24.1.1.dev117+g2962b920 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=43cef8ff"></script>
+    <script src="../../../../_static/documentation_options.js?v=47389ba2"></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.dev116+g0181b3fd';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '24.1.1.dev117+g2962b920';
         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.dev116+g0181b3fd" />
+  <meta name="docsearch:version" content="24.1.1.dev117+g2962b920" />
   </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.dev116+g0181b3fd documentation</title>
+    <title>cil.framework.block &#8212; CIL 24.1.1.dev117+g2962b920 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=43cef8ff"></script>
+    <script src="../../../../_static/documentation_options.js?v=47389ba2"></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.dev116+g0181b3fd';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '24.1.1.dev117+g2962b920';
         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.dev116+g0181b3fd" />
+  <meta name="docsearch:version" content="24.1.1.dev117+g2962b920" />
   </head>
 
 

diff --git a/nightly/_modules/cil/framework/data_container/index.html b/nightly/_modules/cil/framework/data_container/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.data_container &#8212; CIL 24.1.1.dev116+g0181b3fd documentation</title>
+    <title>cil.framework.data_container &#8212; CIL 24.1.1.dev117+g2962b920 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=43cef8ff"></script>
+    <script src="../../../../_static/documentation_options.js?v=47389ba2"></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.dev116+g0181b3fd';
+        DOCUMENTATION_OPTIONS.theme_switcher_version_match = '24.1.1.dev117+g2962b920';
         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.dev116+g0181b3fd" />
+  <meta name="docsearch:version" content="24.1.1.dev117+g2962b920" />
   </head>