Skip to content

Commit

Permalink
Update documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
@crisingulani
crisingulani committed Oct 18, 2023
1 parent c43cc5f commit 92a7763
Show file tree
Hide file tree
Showing 32 changed files with 6,854 additions and 550 deletions.
2 changes: 1 addition & 1 deletion docs/.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: 20de538d23999e0682f5043704a6a894
config: bc064b999073f39c5268b1314d8c5e6f
tags: 645f666f9bcd5a90fca523b33c5a78b7
Binary file added docs/_images/notebooks_intro_notebook_65_0.png
View file
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 docs/_images/notebooks_intro_notebook_67_1.png
View file
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 docs/_images/notebooks_intro_notebook_74_0.png
View file
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
6 changes: 3 additions & 3 deletions docs/_modules/index.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>Overview: module code &mdash; pzserver 0.1.dev1+ga41731a documentation</title>
<title>Overview: module code &mdash; pzserver 0.2.2.dev7+g095ab2f documentation</title>
<link rel="stylesheet" href="../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -32,7 +32,7 @@
pzserver
</a>
<div class="version">
0.1
0.2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../search.html" method="get">
Expand All @@ -47,7 +47,7 @@
<li class="toctree-l1"><a class="reference internal" href="../index.html">Home page</a></li>
<li class="toctree-l1"><a class="reference internal" href="../installation.html">Install</a></li>
<li class="toctree-l1"><a class="reference internal" href="../autoapi/index.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../notebooks.html">Notebooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../nbs.html">Notebooks</a></li>
</ul>

</div>
Expand Down
26 changes: 13 additions & 13 deletions docs/_modules/pzserver/catalog.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
<head>
<meta charset="utf-8" />
<meta name="viewport" content="width=device-width, initial-scale=1.0" />
<title>pzserver.catalog &mdash; pzserver 0.1.dev1+ga41731a documentation</title>
<title>pzserver.catalog &mdash; pzserver 0.2.2.dev7+g095ab2f documentation</title>
<link rel="stylesheet" href="../../_static/pygments.css" type="text/css" />
<link rel="stylesheet" href="../../_static/css/theme.css" type="text/css" />
<link rel="stylesheet" href="../../_static/graphviz.css" type="text/css" />
Expand Down Expand Up @@ -32,7 +32,7 @@
pzserver
</a>
<div class="version">
0.1
0.2
</div>
<div role="search">
<form id="rtd-search-form" class="wy-form" action="../../search.html" method="get">
Expand All @@ -47,7 +47,7 @@
<li class="toctree-l1"><a class="reference internal" href="../../index.html">Home page</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../installation.html">Install</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../autoapi/index.html">API Reference</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../notebooks.html">Notebooks</a></li>
<li class="toctree-l1"><a class="reference internal" href="../../nbs.html">Notebooks</a></li>
</ul>

</div>
Expand Down Expand Up @@ -85,21 +85,21 @@ <h1>Source code for pzserver.catalog</h1><div class="highlight"><pre>


<div class="viewcode-block" id="Catalog"><a class="viewcode-back" href="../../autoapi/pzserver/index.html#pzserver.catalog.Catalog">[docs]</a><span class="k">class</span> <span class="nc">Catalog</span><span class="p">:</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Main class for loading catalog</span>
<span class="sd"> &quot;&quot;&quot;</span>

<span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">data</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">metadata_df</span><span class="o">=</span><span class="kc">None</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Catalog class constructor</span>
<span class="sd"> &quot;&quot;&quot;</span>
<span class="bp">self</span><span class="o">.</span><span class="n">data</span> <span class="o">=</span> <span class="n">pd</span><span class="o">.</span><span class="n">DataFrame</span><span class="p">(</span><span class="n">data</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata</span> <span class="o">=</span> <span class="n">metadata</span>
<span class="bp">self</span><span class="o">.</span><span class="n">columns</span> <span class="o">=</span> <span class="n">metadata</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;main_file&quot;</span><span class="p">)</span><span class="o">.</span><span class="n">get</span><span class="p">(</span><span class="s2">&quot;columns_association&quot;</span><span class="p">)</span>
<span class="bp">self</span><span class="o">.</span><span class="n">metadata_df</span> <span class="o">=</span> <span class="n">metadata_df</span>

<div class="viewcode-block" id="Catalog.display_metadata"><a class="viewcode-back" href="../../autoapi/pzserver/catalog/index.html#pzserver.catalog.Catalog.display_metadata">[docs]</a> <span class="k">def</span> <span class="nf">display_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<div class="viewcode-block" id="Catalog.display_metadata"><a class="viewcode-back" href="../../autoapi/pzserver/index.html#pzserver.catalog.Catalog.display_metadata">[docs]</a> <span class="k">def</span> <span class="nf">display_metadata</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Displays the catalog&#39;s metadata</span>

<span class="sd"> Displays a pandas.io.formats.style.Styler object</span>
Expand All @@ -111,15 +111,15 @@ <h1>Source code for pzserver.catalog</h1><div class="highlight"><pre>


<div class="viewcode-block" id="SpeczCatalog"><a class="viewcode-back" href="../../autoapi/pzserver/index.html#pzserver.catalog.SpeczCatalog">[docs]</a><span class="k">class</span> <span class="nc">SpeczCatalog</span><span class="p">(</span><span class="n">Catalog</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> SpeczCatalog</span>

<span class="sd"> Args:</span>
<span class="sd"> Catalog (_type_): _description_</span>
<span class="sd"> &quot;&quot;&quot;</span>

<div class="viewcode-block" id="SpeczCatalog.plot"><a class="viewcode-back" href="../../autoapi/pzserver/catalog/index.html#pzserver.catalog.SpeczCatalog.plot">[docs]</a> <span class="k">def</span> <span class="nf">plot</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">savefig</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<div class="viewcode-block" id="SpeczCatalog.plot"><a class="viewcode-back" href="../../autoapi/pzserver/index.html#pzserver.catalog.SpeczCatalog.plot">[docs]</a> <span class="k">def</span> <span class="nf">plot</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">savefig</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> Very basic plots to characterize a Spec-z catalog.</span>

<span class="sd"> Args:</span>
Expand Down Expand Up @@ -161,15 +161,15 @@ <h1>Source code for pzserver.catalog</h1><div class="highlight"><pre>


<div class="viewcode-block" id="TrainingSet"><a class="viewcode-back" href="../../autoapi/pzserver/index.html#pzserver.catalog.TrainingSet">[docs]</a><span class="k">class</span> <span class="nc">TrainingSet</span><span class="p">(</span><span class="n">Catalog</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;</span>
<span class="sd">&quot;&quot;&quot;</span>
<span class="sd"> TrainingSet</span>

<span class="sd"> Args:</span>
<span class="sd"> Catalog (_type_): _description_</span>
<span class="sd"> &quot;&quot;&quot;</span>

<div class="viewcode-block" id="TrainingSet.plot"><a class="viewcode-back" href="../../autoapi/pzserver/catalog/index.html#pzserver.catalog.TrainingSet.plot">[docs]</a> <span class="k">def</span> <span class="nf">plot</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mag_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">savefig</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="w"> </span><span class="sd">&quot;&quot;&quot;Very basic plots to characterize a Training Set.</span>
<div class="viewcode-block" id="TrainingSet.plot"><a class="viewcode-back" href="../../autoapi/pzserver/index.html#pzserver.catalog.TrainingSet.plot">[docs]</a> <span class="k">def</span> <span class="nf">plot</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">mag_name</span><span class="o">=</span><span class="kc">None</span><span class="p">,</span> <span class="n">savefig</span><span class="o">=</span><span class="kc">False</span><span class="p">):</span>
<span class="sd">&quot;&quot;&quot;Very basic plots to characterize a Training Set.</span>

<span class="sd"> Args:</span>
<span class="sd"> savefig: option to save PNG figure (boolean)</span>
Expand Down
Loading

0 comments on commit 92a7763

Please sign in to comment.