Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@github-actions
github-actions[bot] committed Oct 16, 2024
1 parent dc1e3d8 commit 7e21633
Show file tree
Hide file tree
Showing 125 changed files with 572 additions and 553 deletions.
2 changes: 1 addition & 1 deletion assets/css/atom.css.map
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion assets/css/rss.css.map
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion assets/css/styles_feeling_responsive.css.map
View file

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion nightly/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file records the configuration used when building these files. When it is not found, a full rebuild will be done.
config: eefab179e8f98310647ee71a8279c701
config: 2aa2d451055aa2d3e0c1176416f6ea5c
tags: d77d1c0d9ca2f4c8421862c7c5a0d620
Binary file modified nightly/.doctrees/demos.doctree
View file
Binary file not shown.
Binary file modified nightly/.doctrees/demos/00_CIL_geometry.doctree
View file
Binary file not shown.
Binary file modified nightly/.doctrees/demos/callback_demonstration.doctree
View file
Binary file not shown.
Binary file modified nightly/.doctrees/demos/deriv2_cgls.doctree
View file
Binary file not shown.
Binary file modified nightly/.doctrees/developer_guide.doctree
View file
Binary file not shown.
Binary file modified nightly/.doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified nightly/.doctrees/framework.doctree
View file
Binary file not shown.
Binary file modified nightly/.doctrees/index.doctree
View file
Binary file not shown.
Binary file modified nightly/.doctrees/introduction.doctree
View file
Binary file not shown.
Binary file modified nightly/.doctrees/io.doctree
View file
Binary file not shown.
112 changes: 56 additions & 56 deletions nightly/.doctrees/nbsphinx/demos/00_CIL_geometry.ipynb
View file
Original file line number Diff line number Diff line change
Expand Up @@ -5,10 +5,10 @@
"execution_count": 1,
"metadata": {
"execution": {
"iopub.execute_input": "2024-10-11T11:00:28.244157Z",
"iopub.status.busy": "2024-10-11T11:00:28.243999Z",
"iopub.status.idle": "2024-10-11T11:00:28.247057Z",
"shell.execute_reply": "2024-10-11T11:00:28.246604Z"
"iopub.execute_input": "2024-10-16T11:20:48.316687Z",
"iopub.status.busy": "2024-10-16T11:20:48.316531Z",
"iopub.status.idle": "2024-10-16T11:20:48.319356Z",
"shell.execute_reply": "2024-10-16T11:20:48.318998Z"
}
},
"outputs": [],
Expand Down Expand Up @@ -142,10 +142,10 @@
"execution_count": 2,
"metadata": {
"execution": {
"iopub.execute_input": "2024-10-11T11:00:28.248713Z",
"iopub.status.busy": "2024-10-11T11:00:28.248360Z",
"iopub.status.idle": "2024-10-11T11:00:29.063056Z",
"shell.execute_reply": "2024-10-11T11:00:29.062551Z"
"iopub.execute_input": "2024-10-16T11:20:48.320979Z",
"iopub.status.busy": "2024-10-16T11:20:48.320649Z",
"iopub.status.idle": "2024-10-16T11:20:49.136488Z",
"shell.execute_reply": "2024-10-16T11:20:49.135977Z"
}
},
"outputs": [
Expand Down Expand Up @@ -209,10 +209,10 @@
"execution_count": 3,
"metadata": {
"execution": {
"iopub.execute_input": "2024-10-11T11:00:29.092286Z",
"iopub.status.busy": "2024-10-11T11:00:29.092032Z",
"iopub.status.idle": "2024-10-11T11:00:29.322402Z",
"shell.execute_reply": "2024-10-11T11:00:29.321923Z"
"iopub.execute_input": "2024-10-16T11:20:49.165339Z",
"iopub.status.busy": "2024-10-16T11:20:49.164940Z",
"iopub.status.idle": "2024-10-16T11:20:49.397847Z",
"shell.execute_reply": "2024-10-16T11:20:49.397299Z"
}
},
"outputs": [
Expand All @@ -229,7 +229,7 @@
{
"data": {
"text/plain": [
"<cil.utilities.display.show_geometry at 0x7f17effcc290>"
"<cil.utilities.display.show_geometry at 0x7f9208252a20>"
]
},
"execution_count": 3,
Expand Down Expand Up @@ -271,10 +271,10 @@
"execution_count": 4,
"metadata": {
"execution": {
"iopub.execute_input": "2024-10-11T11:00:29.324188Z",
"iopub.status.busy": "2024-10-11T11:00:29.323797Z",
"iopub.status.idle": "2024-10-11T11:00:29.519777Z",
"shell.execute_reply": "2024-10-11T11:00:29.519284Z"
"iopub.execute_input": "2024-10-16T11:20:49.399757Z",
"iopub.status.busy": "2024-10-16T11:20:49.399307Z",
"iopub.status.idle": "2024-10-16T11:20:49.594583Z",
"shell.execute_reply": "2024-10-16T11:20:49.594057Z"
}
},
"outputs": [
Expand All @@ -291,7 +291,7 @@
{
"data": {
"text/plain": [
"<cil.utilities.display.show_geometry at 0x7f17efe250a0>"
"<cil.utilities.display.show_geometry at 0x7f91fbc13560>"
]
},
"execution_count": 4,
Expand Down Expand Up @@ -333,10 +333,10 @@
"execution_count": 5,
"metadata": {
"execution": {
"iopub.execute_input": "2024-10-11T11:00:29.521578Z",
"iopub.status.busy": "2024-10-11T11:00:29.521257Z",
"iopub.status.idle": "2024-10-11T11:00:29.736560Z",
"shell.execute_reply": "2024-10-11T11:00:29.736050Z"
"iopub.execute_input": "2024-10-16T11:20:49.596382Z",
"iopub.status.busy": "2024-10-16T11:20:49.596061Z",
"iopub.status.idle": "2024-10-16T11:20:49.817557Z",
"shell.execute_reply": "2024-10-16T11:20:49.817007Z"
}
},
"outputs": [
Expand All @@ -353,7 +353,7 @@
{
"data": {
"text/plain": [
"<cil.utilities.display.show_geometry at 0x7f17fc425700>"
"<cil.utilities.display.show_geometry at 0x7f91fb398b60>"
]
},
"execution_count": 5,
Expand Down Expand Up @@ -394,10 +394,10 @@
"execution_count": 6,
"metadata": {
"execution": {
"iopub.execute_input": "2024-10-11T11:00:29.738290Z",
"iopub.status.busy": "2024-10-11T11:00:29.738001Z",
"iopub.status.idle": "2024-10-11T11:00:29.928807Z",
"shell.execute_reply": "2024-10-11T11:00:29.928356Z"
"iopub.execute_input": "2024-10-16T11:20:49.819323Z",
"iopub.status.busy": "2024-10-16T11:20:49.818968Z",
"iopub.status.idle": "2024-10-16T11:20:50.011956Z",
"shell.execute_reply": "2024-10-16T11:20:50.011475Z"
}
},
"outputs": [
Expand All @@ -414,7 +414,7 @@
{
"data": {
"text/plain": [
"<cil.utilities.display.show_geometry at 0x7f17fc2ac950>"
"<cil.utilities.display.show_geometry at 0x7f91fb6cf080>"
]
},
"execution_count": 6,
Expand Down Expand Up @@ -447,10 +447,10 @@
"execution_count": 7,
"metadata": {
"execution": {
"iopub.execute_input": "2024-10-11T11:00:29.930550Z",
"iopub.status.busy": "2024-10-11T11:00:29.930207Z",
"iopub.status.idle": "2024-10-11T11:00:30.154898Z",
"shell.execute_reply": "2024-10-11T11:00:30.154387Z"
"iopub.execute_input": "2024-10-16T11:20:50.013586Z",
"iopub.status.busy": "2024-10-16T11:20:50.013415Z",
"iopub.status.idle": "2024-10-16T11:20:50.244464Z",
"shell.execute_reply": "2024-10-16T11:20:50.244007Z"
}
},
"outputs": [
Expand All @@ -467,7 +467,7 @@
{
"data": {
"text/plain": [
"<cil.utilities.display.show_geometry at 0x7f17fc1ae1b0>"
"<cil.utilities.display.show_geometry at 0x7f91fb5a8170>"
]
},
"execution_count": 7,
Expand Down Expand Up @@ -499,10 +499,10 @@
"execution_count": 8,
"metadata": {
"execution": {
"iopub.execute_input": "2024-10-11T11:00:30.156607Z",
"iopub.status.busy": "2024-10-11T11:00:30.156286Z",
"iopub.status.idle": "2024-10-11T11:00:30.371132Z",
"shell.execute_reply": "2024-10-11T11:00:30.370663Z"
"iopub.execute_input": "2024-10-16T11:20:50.246214Z",
"iopub.status.busy": "2024-10-16T11:20:50.245888Z",
"iopub.status.idle": "2024-10-16T11:20:50.464349Z",
"shell.execute_reply": "2024-10-16T11:20:50.463829Z"
}
},
"outputs": [
Expand All @@ -519,7 +519,7 @@
{
"data": {
"text/plain": [
"<cil.utilities.display.show_geometry at 0x7f17fc1c3140>"
"<cil.utilities.display.show_geometry at 0x7f91fb6127e0>"
]
},
"execution_count": 8,
Expand Down Expand Up @@ -549,10 +549,10 @@
"execution_count": 9,
"metadata": {
"execution": {
"iopub.execute_input": "2024-10-11T11:00:30.372642Z",
"iopub.status.busy": "2024-10-11T11:00:30.372478Z",
"iopub.status.idle": "2024-10-11T11:00:30.590144Z",
"shell.execute_reply": "2024-10-11T11:00:30.589621Z"
"iopub.execute_input": "2024-10-16T11:20:50.466012Z",
"iopub.status.busy": "2024-10-16T11:20:50.465826Z",
"iopub.status.idle": "2024-10-16T11:20:50.685020Z",
"shell.execute_reply": "2024-10-16T11:20:50.684411Z"
}
},
"outputs": [
Expand All @@ -569,7 +569,7 @@
{
"data": {
"text/plain": [
"<cil.utilities.display.show_geometry at 0x7f17fc459a90>"
"<cil.utilities.display.show_geometry at 0x7f91fb5dad80>"
]
},
"execution_count": 9,
Expand Down Expand Up @@ -638,10 +638,10 @@
"execution_count": 10,
"metadata": {
"execution": {
"iopub.execute_input": "2024-10-11T11:00:30.591908Z",
"iopub.status.busy": "2024-10-11T11:00:30.591509Z",
"iopub.status.idle": "2024-10-11T11:00:30.596515Z",
"shell.execute_reply": "2024-10-11T11:00:30.596102Z"
"iopub.execute_input": "2024-10-16T11:20:50.686803Z",
"iopub.status.busy": "2024-10-16T11:20:50.686472Z",
"iopub.status.idle": "2024-10-16T11:20:50.691477Z",
"shell.execute_reply": "2024-10-16T11:20:50.690988Z"
}
},
"outputs": [
Expand Down Expand Up @@ -711,10 +711,10 @@
"execution_count": 11,
"metadata": {
"execution": {
"iopub.execute_input": "2024-10-11T11:00:30.598098Z",
"iopub.status.busy": "2024-10-11T11:00:30.597710Z",
"iopub.status.idle": "2024-10-11T11:00:31.230558Z",
"shell.execute_reply": "2024-10-11T11:00:31.230103Z"
"iopub.execute_input": "2024-10-16T11:20:50.693220Z",
"iopub.status.busy": "2024-10-16T11:20:50.692796Z",
"iopub.status.idle": "2024-10-16T11:20:51.353498Z",
"shell.execute_reply": "2024-10-16T11:20:51.353008Z"
}
},
"outputs": [
Expand Down Expand Up @@ -772,7 +772,7 @@
{
"data": {
"text/plain": [
"<cil.utilities.display.show_geometry at 0x7f17efc79a90>"
"<cil.utilities.display.show_geometry at 0x7f92081c8560>"
]
},
"execution_count": 11,
Expand Down Expand Up @@ -815,10 +815,10 @@
"execution_count": 12,
"metadata": {
"execution": {
"iopub.execute_input": "2024-10-11T11:00:31.232076Z",
"iopub.status.busy": "2024-10-11T11:00:31.231916Z",
"iopub.status.idle": "2024-10-11T11:00:31.234345Z",
"shell.execute_reply": "2024-10-11T11:00:31.233974Z"
"iopub.execute_input": "2024-10-16T11:20:51.355014Z",
"iopub.status.busy": "2024-10-16T11:20:51.354836Z",
"iopub.status.idle": "2024-10-16T11:20:51.357565Z",
"shell.execute_reply": "2024-10-16T11:20:51.357092Z"
}
},
"outputs": [],
Expand Down
Binary file modified nightly/.doctrees/optimisation.doctree
View file
Binary file not shown.
Binary file modified nightly/.doctrees/plugins.doctree
View file
Binary file not shown.
Binary file modified nightly/.doctrees/processors.doctree
View file
Binary file not shown.
Binary file modified nightly/.doctrees/recon.doctree
View file
Binary file not shown.
Binary file modified nightly/.doctrees/utilities.doctree
View file
Binary file not shown.
8 changes: 4 additions & 4 deletions nightly/_modules/cil/framework/acquisition_data/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.2.1.dev1+g83894302 documentation</title>
<title>cil.framework.acquisition_data &#8212; CIL 24.2.1.dev2+ga4759748 documentation</title>



Expand Down Expand Up @@ -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=e0479393"></script>
<script src="../../../../_static/documentation_options.js?v=aa252d58"></script>
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -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.2.1.dev1+g83894302';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '24.2.1.dev2+ga4759748';
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.2.1.dev1+g83894302" />
<meta name="docsearch:version" content="24.2.1.dev2+ga4759748" />
</head>


Expand Down
8 changes: 4 additions & 4 deletions nightly/_modules/cil/framework/acquisition_geometry/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.2.1.dev1+g83894302 documentation</title>
<title>cil.framework.acquisition_geometry &#8212; CIL 24.2.1.dev2+ga4759748 documentation</title>



Expand Down Expand Up @@ -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=e0479393"></script>
<script src="../../../../_static/documentation_options.js?v=aa252d58"></script>
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -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.2.1.dev1+g83894302';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '24.2.1.dev2+ga4759748';
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.2.1.dev1+g83894302" />
<meta name="docsearch:version" content="24.2.1.dev2+ga4759748" />
</head>


Expand Down
8 changes: 4 additions & 4 deletions nightly/_modules/cil/framework/block/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.2.1.dev1+g83894302 documentation</title>
<title>cil.framework.block &#8212; CIL 24.2.1.dev2+ga4759748 documentation</title>



Expand Down Expand Up @@ -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=e0479393"></script>
<script src="../../../../_static/documentation_options.js?v=aa252d58"></script>
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -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.2.1.dev1+g83894302';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '24.2.1.dev2+ga4759748';
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.2.1.dev1+g83894302" />
<meta name="docsearch:version" content="24.2.1.dev2+ga4759748" />
</head>


Expand Down
8 changes: 4 additions & 4 deletions nightly/_modules/cil/framework/data_container/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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.2.1.dev1+g83894302 documentation</title>
<title>cil.framework.data_container &#8212; CIL 24.2.1.dev2+ga4759748 documentation</title>



Expand Down Expand Up @@ -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=e0479393"></script>
<script src="../../../../_static/documentation_options.js?v=aa252d58"></script>
<script src="../../../../_static/doctools.js?v=9bcbadda"></script>
<script src="../../../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../../../_static/clipboard.min.js?v=a7894cd8"></script>
Expand All @@ -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.2.1.dev1+g83894302';
DOCUMENTATION_OPTIONS.theme_switcher_version_match = '24.2.1.dev2+ga4759748';
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.2.1.dev1+g83894302" />
<meta name="docsearch:version" content="24.2.1.dev2+ga4759748" />
</head>


Expand Down
Loading

0 comments on commit 7e21633

Please sign in to comment.