Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
Unknown committed Aug 12, 2024
0 parents commit 79f8d46
Show file tree
Hide file tree
Showing 250 changed files with 37,688 additions and 0 deletions.
4 changes: 4 additions & 0 deletions .buildinfo
Original file line number Diff line number Diff line change
@@ -0,0 +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: 688e180c636424fa7131b68b7068aeaf
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added .doctrees/api/tomophantom.TomoP2D.doctree
Binary file not shown.
Binary file added .doctrees/api/tomophantom.TomoP3D.doctree
Binary file not shown.
Binary file added .doctrees/api/tomophantom.artefacts.doctree
Binary file not shown.
Binary file added .doctrees/api/tomophantom.ctypes.doctree
Binary file not shown.
Binary file added .doctrees/api/tomophantom.ctypes.dtype.doctree
Binary file not shown.
Binary file added .doctrees/api/tomophantom.ctypes.external.doctree
Binary file not shown.
Binary file added .doctrees/api/tomophantom.doctree
Binary file not shown.
Binary file added .doctrees/api/tomophantom.flatsgen.doctree
Binary file not shown.
Binary file added .doctrees/api/tomophantom.generator.doctree
Binary file not shown.
Binary file added .doctrees/api/tomophantom.qualitymetrics.doctree
Binary file not shown.
Binary file added .doctrees/api/tomophantom.supp.doctree
Binary file not shown.
Binary file added .doctrees/api/tomophantom.supp.libraryToDict.doctree
Binary file not shown.
Binary file added .doctrees/api/tomophantom.supp.speckle_routines.doctree
Binary file not shown.
Binary file added .doctrees/environment.pickle
Binary file not shown.
Binary file added .doctrees/howto/installation.doctree
Binary file not shown.
Binary file added .doctrees/index.doctree
Binary file not shown.
Binary file added .doctrees/introduction/about.doctree
Binary file not shown.
Binary file added .doctrees/introduction/libraries.doctree
Binary file not shown.
Binary file added .doctrees/reference/api.doctree
Binary file not shown.
Empty file added .nojekyll
Empty file.
Binary file added _images/2DtModel14.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/model05.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/model11_4D.gif
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/tomo3d.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added _images/tomophantom_apps.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
329 changes: 329 additions & 0 deletions _modules/index.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,329 @@


<!DOCTYPE html>


<html lang="en" >

<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &#8212; Tomophantom Documentation page</title>



<script data-cfasync="false">
document.documentElement.dataset.mode = localStorage.getItem("mode") || "";
document.documentElement.dataset.theme = localStorage.getItem("theme") || "light";
</script>

<!-- Loaded before other Sphinx assets -->
<link href="../_static/styles/theme.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="../_static/styles/bootstrap.css?digest=e353d410970836974a52" rel="stylesheet" />
<link href="../_static/styles/pydata-sphinx-theme.css?digest=e353d410970836974a52" rel="stylesheet" />


<link href="../_static/vendor/fontawesome/6.1.2/css/all.min.css?digest=e353d410970836974a52" rel="stylesheet" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-solid-900.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-brands-400.woff2" />
<link rel="preload" as="font" type="font/woff2" crossorigin href="../_static/vendor/fontawesome/6.1.2/webfonts/fa-regular-400.woff2" />

<link rel="stylesheet" type="text/css" href="../_static/pygments.css" />
<link rel="stylesheet" href="../_static/styles/sphinx-book-theme.css?digest=14f4ca6b54d191a8c7657f6c759bf11a5fb86285" type="text/css" />
<link rel="stylesheet" type="text/css" href="../_static/copybutton.css" />
<link rel="stylesheet" type="text/css" href="../_static/css/general.css" />
<link rel="stylesheet" type="text/css" href="../_static/panels-main.c949a650a448cc0ae9fd3441c0e17fb0.css" />
<link rel="stylesheet" type="text/css" href="../_static/panels-bootstrap.5fd3999ee7762ccc51105388f4a9d115.css" />
<link rel="stylesheet" type="text/css" href="../_static/panels-variables.06eb56fa6e07937060861dad626602ad.css" />

<!-- Pre-loaded scripts that we'll load fully later -->
<link rel="preload" as="script" href="../_static/scripts/bootstrap.js?digest=e353d410970836974a52" />
<link rel="preload" as="script" href="../_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52" />

<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/underscore.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/clipboard.min.js"></script>
<script src="../_static/copybutton.js"></script>
<script src="../_static/scripts/sphinx-book-theme.js?digest=5a5c038af52cf7bc1a1ec88eea08e6366ee68824"></script>
<script>DOCUMENTATION_OPTIONS.pagename = '_modules/index';</script>
<link rel="shortcut icon" href="../_static/tomophantom_logo_light.png"/>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
<meta name="viewport" content="width=device-width, initial-scale=1"/>
<meta name="docsearch:language" content="en"/>
</head>


<body data-bs-spy="scroll" data-bs-target=".bd-toc-nav" data-offset="180" data-bs-root-margin="0px 0px -60%" data-default-mode="">



<a class="skip-link" href="#main-content">Skip to main content</a>

<input type="checkbox"
class="sidebar-toggle"
name="__primary"
id="__primary"/>
<label class="overlay overlay-primary" for="__primary"></label>

<input type="checkbox"
class="sidebar-toggle"
name="__secondary"
id="__secondary"/>
<label class="overlay overlay-secondary" for="__secondary"></label>

<div class="search-button__wrapper">
<div class="search-button__overlay"></div>
<div class="search-button__search-container">
<form class="bd-search d-flex align-items-center"
action="../search.html"
method="get">
<i class="fa-solid fa-magnifying-glass"></i>
<input type="search"
class="form-control"
name="q"
id="search-input"
placeholder="Search..."
aria-label="Search..."
autocomplete="off"
autocorrect="off"
autocapitalize="off"
spellcheck="false"/>
<span class="search-button__kbd-shortcut"><kbd class="kbd-shortcut__modifier">Ctrl</kbd>+<kbd>K</kbd></span>
</form></div>
</div>

<nav class="bd-header navbar navbar-expand-lg bd-navbar">
</nav>

<div class="bd-container">
<div class="bd-container__inner bd-page-width">

<div class="bd-sidebar-primary bd-sidebar">



<div class="sidebar-header-items sidebar-primary__section">




</div>

<div class="sidebar-primary-items__start sidebar-primary__section">
<div class="sidebar-primary-item">


<a class="navbar-brand logo" href="../index.html">









<img src="../_static/tomophantom_logo_light.png" class="logo__image only-light" alt="Logo image"/>
<script>document.write(`<img src="../_static/tomophantom_logo_dark.png" class="logo__image only-dark" alt="Logo image"/>`);</script>


</a></div>
<div class="sidebar-primary-item"><nav class="bd-links" id="bd-docs-nav" aria-label="Main">
<div class="bd-toc-item navbar-nav active">
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Introduction</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../introduction/about.html">About TomoPhantom</a></li>
<li class="toctree-l1"><a class="reference internal" href="../introduction/libraries.html">Phantom Libraries</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">How To's</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1"><a class="reference internal" href="../howto/installation.html">Installation Guide</a></li>
</ul>
<p aria-level="2" class="caption" role="heading"><span class="caption-text">Reference guides</span></p>
<ul class="nav bd-sidenav">
<li class="toctree-l1 has-children"><a class="reference internal" href="../reference/api.html">API reference</a><input class="toctree-checkbox" id="toctree-checkbox-1" name="toctree-checkbox-1" type="checkbox"/><label class="toctree-toggle" for="toctree-checkbox-1"><i class="fa-solid fa-chevron-down"></i></label><ul>
<li class="toctree-l2"><a class="reference internal" href="../api/tomophantom.TomoP2D.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tomophantom.TomoP2D</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../api/tomophantom.TomoP3D.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tomophantom.TomoP3D</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../api/tomophantom.artefacts.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tomophantom.artefacts</span></code></a></li>
<li class="toctree-l2"><a class="reference internal" href="../api/tomophantom.flatsgen.html"><code class="xref py py-mod docutils literal notranslate"><span class="pre">tomophantom.flatsgen</span></code></a></li>
</ul>
</li>
</ul>

</div>
</nav></div>
</div>


<div class="sidebar-primary-items__end sidebar-primary__section">
</div>

<div id="rtd-footer-container"></div>


</div>

<main id="main-content" class="bd-main">



<div class="sbt-scroll-pixel-helper"></div>

<div class="bd-content">
<div class="bd-article-container">

<div class="bd-header-article">
<div class="header-article-items header-article__inner">

<div class="header-article-items__start">

<div class="header-article-item"><label class="sidebar-toggle primary-toggle btn btn-sm" for="__primary" title="Toggle primary sidebar" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="fa-solid fa-bars"></span>
</label></div>

</div>


<div class="header-article-items__end">

<div class="header-article-item">

<div class="article-header-buttons">



<button onclick="toggleFullScreen()"
class="btn btn-sm btn-fullscreen-button"
title="Fullscreen mode"
data-bs-placement="bottom" data-bs-toggle="tooltip"
>


<span class="btn__icon-container">
<i class="fas fa-expand"></i>
</span>

</button>


<script>
document.write(`
<button class="theme-switch-button btn btn-sm btn-outline-primary navbar-btn rounded-circle" title="light/dark" aria-label="light/dark" data-bs-placement="bottom" data-bs-toggle="tooltip">
<span class="theme-switch" data-mode="light"><i class="fa-solid fa-sun"></i></span>
<span class="theme-switch" data-mode="dark"><i class="fa-solid fa-moon"></i></span>
<span class="theme-switch" data-mode="auto"><i class="fa-solid fa-circle-half-stroke"></i></span>
</button>
`);
</script>

<script>
document.write(`
<button class="btn btn-sm navbar-btn search-button search-button__button" title="Search" aria-label="Search" data-bs-placement="bottom" data-bs-toggle="tooltip">
<i class="fa-solid fa-magnifying-glass"></i>
</button>
`);
</script>

</div></div>

</div>

</div>
</div>



<div id="jb-print-docs-body" class="onlyprint">
<h1></h1>
<!-- Table of contents -->
<div id="print-main-content">
<div id="jb-print-toc">

</div>
</div>
</div>



<div id="searchbox"></div>
<article class="bd-article" role="main">

<h1>All modules for which code is available</h1>
<ul><li><a href="tomophantom/TomoP2D.html">tomophantom.TomoP2D</a></li>
<li><a href="tomophantom/TomoP3D.html">tomophantom.TomoP3D</a></li>
<li><a href="tomophantom/artefacts.html">tomophantom.artefacts</a></li>
<li><a href="tomophantom/ctypes.html">tomophantom.ctypes</a></li>
<ul><li><a href="tomophantom/ctypes/dtype.html">tomophantom.ctypes.dtype</a></li>
<li><a href="tomophantom/ctypes/external.html">tomophantom.ctypes.external</a></li>
</ul><li><a href="tomophantom/flatsgen.html">tomophantom.flatsgen</a></li>
<li><a href="tomophantom/generator.html">tomophantom.generator</a></li>
<li><a href="tomophantom/qualitymetrics.html">tomophantom.qualitymetrics</a></li>
<li><a href="tomophantom/supp/libraryToDict.html">tomophantom.supp.libraryToDict</a></li>
<li><a href="tomophantom/supp/speckle_routines.html">tomophantom.supp.speckle_routines</a></li>
</ul>

</article>




<footer class="bd-footer-article">

<div class="footer-article-items footer-article__inner">

<div class="footer-article-item"><!-- Previous / next buttons -->
<div class="prev-next-area">
</div></div>

</div>

</footer>

</div>




</div>
<footer class="bd-footer-content">

<div class="bd-footer-content__inner container">

<div class="footer-item">

</div>

<div class="footer-item">

</div>

<div class="footer-item">
<p class="last-updated">
Last updated on Aug 12, 2024.
<br/>
</p>
</div>

<div class="footer-item">

</div>

</div>
</footer>


</main>
</div>
</div>

<!-- Scripts loaded after <body> so the DOM is not blocked -->
<script src="../_static/scripts/bootstrap.js?digest=e353d410970836974a52"></script>
<script src="../_static/scripts/pydata-sphinx-theme.js?digest=e353d410970836974a52"></script>

<footer class="bd-footer">
</footer>
</body>
</html>
Loading

0 comments on commit 79f8d46

Please sign in to comment.