Skip to content

Commit

Permalink
build docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@rmjarvis
rmjarvis committed Jul 12, 2024
1 parent 72f114f commit 9d5df7d
Show file tree
Hide file tree
Showing 72 changed files with 3,266 additions and 1,793 deletions.
Binary file modified docs/_build/doctrees/environment.pickle
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/index.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/input.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/interp.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/model.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/outliers.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/output.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/overview.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/piffify.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/psf.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/select.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/star.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/stats.doctree
View file
Binary file not shown.
Binary file modified docs/_build/doctrees/util.doctree
View file
Binary file not shown.
2 changes: 1 addition & 1 deletion docs/_build/html/.buildinfo
View file
Original file line number Diff line number Diff line change
@@ -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: e2843d7825090cc82ebbd6d05a8e535e
config: 0f4ef1b48a32a58b3e7e62f83a0f5435
tags: 645f666f9bcd5a90fca523b33c5a78b7
20 changes: 10 additions & 10 deletions docs/_build/html/_modules/index.html
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../">
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; Piff 1.4.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../_static/css/theme.css?v=19f00094" />


<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="../_static/jquery.js?v=5d32c60e"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../_static/documentation_options.js?v=9172181d"></script>
<script src="../_static/doctools.js?v=9a2dae69"></script>
<script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../_static/jquery.js"></script>
<script src="../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../" id="documentation_options" src="../_static/documentation_options.js"></script>
<script src="../_static/doctools.js"></script>
<script src="../_static/sphinx_highlight.js"></script>
<script src="../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../genindex.html" />
<link rel="search" title="Search" href="../search.html" />
Expand Down Expand Up @@ -85,6 +83,7 @@
<h1>All modules for which code is available</h1>
<ul><li><a href="piff/basis_interp.html">piff.basis_interp</a></li>
<li><a href="piff/config.html">piff.config</a></li>
<li><a href="piff/convolvepsf.html">piff.convolvepsf</a></li>
<li><a href="piff/gp_interp.html">piff.gp_interp</a></li>
<li><a href="piff/gsobject_model.html">piff.gsobject_model</a></li>
<li><a href="piff/input.html">piff.input</a></li>
Expand All @@ -105,6 +104,7 @@ <h1>All modules for which code is available</h1>
<li><a href="piff/star.html">piff.star</a></li>
<li><a href="piff/star_stats.html">piff.star_stats</a></li>
<li><a href="piff/stats.html">piff.stats</a></li>
<li><a href="piff/sumpsf.html">piff.sumpsf</a></li>
<li><a href="piff/twod_stats.html">piff.twod_stats</a></li>
<li><a href="piff/util.html">piff.util</a></li>
</ul>
Expand Down
86 changes: 27 additions & 59 deletions docs/_build/html/_modules/piff/basis_interp.html
View file

Large diffs are not rendered by default.

38 changes: 12 additions & 26 deletions docs/_build/html/_modules/piff/config.html
View file
Original file line number Diff line number Diff line change
@@ -1,22 +1,20 @@
<!DOCTYPE html>
<html class="writer-html5" lang="en" data-content_root="../../">
<html class="writer-html5" lang="en" >
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>piff.config &mdash; Piff 1.4.0 documentation</title>
<link rel="stylesheet" type="text/css" href="../../_static/pygments.css?v=fa44fd50" />
<link rel="stylesheet" type="text/css" href="../../_static/css/theme.css?v=19f00094" />


<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<!--[if lt IE 9]>
<script src="../../_static/js/html5shiv.min.js"></script>
<![endif]-->

<script src="../../_static/jquery.js?v=5d32c60e"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js?v=2cd50e6c"></script>
<script src="../../_static/documentation_options.js?v=9172181d"></script>
<script src="../../_static/doctools.js?v=9a2dae69"></script>
<script src="../../_static/sphinx_highlight.js?v=dc90522c"></script>
<script src="../../_static/jquery.js"></script>
<script src="../../_static/_sphinx_javascript_frameworks_compat.js"></script>
<script data-url_root="../../" id="documentation_options" src="../../_static/documentation_options.js"></script>
<script src="../../_static/doctools.js"></script>
<script src="../../_static/sphinx_highlight.js"></script>
<script src="../../_static/js/theme.js"></script>
<link rel="index" title="Index" href="../../genindex.html" />
<link rel="search" title="Search" href="../../search.html" />
Expand Down Expand Up @@ -106,9 +104,7 @@ <h1>Source code for piff.config</h1><div class="highlight"><pre>
<span class="kn">import</span> <span class="nn">os</span>
<span class="kn">import</span> <span class="nn">galsim</span>

<div class="viewcode-block" id="setup_logger">
<a class="viewcode-back" href="../../piffify.html#piff.setup_logger">[docs]</a>
<span class="k">def</span> <span class="nf">setup_logger</span><span class="p">(</span><span class="n">verbose</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">log_file</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<div class="viewcode-block" id="setup_logger"><a class="viewcode-back" href="../../piffify.html#piff.setup_logger">[docs]</a><span class="k">def</span> <span class="nf">setup_logger</span><span class="p">(</span><span class="n">verbose</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span> <span class="n">log_file</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Build a logger object to use for logging progress</span>

<span class="sd"> Note: This will update the verbosity if a previous call to setup_logger used a different</span>
Expand Down Expand Up @@ -143,10 +139,7 @@ <h1>Source code for piff.config</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="n">logger</span></div>



<div class="viewcode-block" id="parse_variables">
<a class="viewcode-back" href="../../piffify.html#piff.parse_variables">[docs]</a>
<span class="k">def</span> <span class="nf">parse_variables</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">variables</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
<div class="viewcode-block" id="parse_variables"><a class="viewcode-back" href="../../piffify.html#piff.parse_variables">[docs]</a><span class="k">def</span> <span class="nf">parse_variables</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">variables</span><span class="p">,</span> <span class="n">logger</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Parse configuration variables and add them to the config dict</span>

<span class="sd"> The command line variables should be specified as key=value.</span>
Expand Down Expand Up @@ -174,10 +167,7 @@ <h1>Source code for piff.config</h1><div class="highlight"><pre>
<span class="n">new_params</span><span class="p">[</span><span class="n">key</span><span class="p">]</span> <span class="o">=</span> <span class="n">value</span>
<span class="n">galsim</span><span class="o">.</span><span class="n">config</span><span class="o">.</span><span class="n">UpdateConfig</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">new_params</span><span class="p">)</span></div>


<div class="viewcode-block" id="read_config">
<a class="viewcode-back" href="../../piffify.html#piff.read_config">[docs]</a>
<span class="k">def</span> <span class="nf">read_config</span><span class="p">(</span><span class="n">file_name</span><span class="p">):</span>
<div class="viewcode-block" id="read_config"><a class="viewcode-back" href="../../piffify.html#piff.read_config">[docs]</a><span class="k">def</span> <span class="nf">read_config</span><span class="p">(</span><span class="n">file_name</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Read a configuration dict from a file.</span>

<span class="sd"> :param file_name: The file name from which the configuration dict should be read.</span>
Expand All @@ -187,7 +177,6 @@ <h1>Source code for piff.config</h1><div class="highlight"><pre>
<span class="k">return</span> <span class="n">config</span></div>



<span class="k">def</span> <span class="nf">process</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">logger</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Build a Piff model according to the specifications in a config dict.</span>

Expand Down Expand Up @@ -241,9 +230,7 @@ <h1>Source code for piff.config</h1><div class="highlight"><pre>

<span class="k">return</span> <span class="n">psf</span>

<div class="viewcode-block" id="piffify">
<a class="viewcode-back" href="../../piffify.html#piff.piffify">[docs]</a>
<span class="k">def</span> <span class="nf">piffify</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">logger</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<div class="viewcode-block" id="piffify"><a class="viewcode-back" href="../../piffify.html#piff.piffify">[docs]</a><span class="k">def</span> <span class="nf">piffify</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">logger</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Build a Piff model according to the specifications in a config dict.</span>

<span class="sd"> This includes writing the model to disk according to the output field.</span>
Expand All @@ -268,7 +255,6 @@ <h1>Source code for piff.config</h1><div class="highlight"><pre>
<span class="n">output</span> <span class="o">=</span> <span class="n">Output</span><span class="o">.</span><span class="n">process</span><span class="p">(</span><span class="n">config</span><span class="p">[</span><span class="s1">&#39;output&#39;</span><span class="p">],</span> <span class="n">logger</span><span class="o">=</span><span class="n">logger</span><span class="p">)</span>
<span class="n">output</span><span class="o">.</span><span class="n">write</span><span class="p">(</span><span class="n">psf</span><span class="p">,</span> <span class="n">logger</span><span class="o">=</span><span class="n">logger</span><span class="p">)</span></div>


<span class="k">def</span> <span class="nf">plotify</span><span class="p">(</span><span class="n">config</span><span class="p">,</span> <span class="n">logger</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Take a Piff model, load in images, and execute output.</span>

Expand Down
Loading

0 comments on commit 9d5df7d

Please sign in to comment.