Update workflow documentation

Lexi-BU · Dec 24, 2024 · 235baf6 · 235baf6
1 parent a8d0380
commit 235baf6
Show file tree

Hide file tree

Showing 8 changed files with 140 additions and 1 deletion.
diff --git a/rst_files/array_to_image/index.html b/rst_files/array_to_image/index.html
@@ -234,6 +234,45 @@ <h2>Example Usage<a class="headerlink" href="#example-usage" title="Link to this
 </div>
 </div>
 </section>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>input_array</strong> (<em>numpy.ndarray</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>key</strong> (<em>str</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>x_range</strong> (<em>list</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>y_range</strong> (<em>list</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>x_lim</strong> (<em>list</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>y_lim</strong> (<em>list</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>start_time</strong> (<em>pandas.Timestamp</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>stop_time</strong> (<em>pandas.Timestamp</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>ra_res</strong> (<em>float</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>dec_res</strong> (<em>float</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>time_integrate</strong> (<em>float</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>cmap</strong> (<em>str</em>)</p></li>
+<li><p><strong>cmin</strong> (<em>float</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>v_min</strong> (<em>float</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>v_max</strong> (<em>float</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>norm</strong> (<em>matplotlib.colors.LogNorm</em>)</p></li>
+<li><p><strong>norm_type</strong> (<em>str</em>)</p></li>
+<li><p><strong>aspect</strong> (<em>str</em>)</p></li>
+<li><p><strong>figure_title</strong> (<em>str</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>show_colorbar</strong> (<em>bool</em>)</p></li>
+<li><p><strong>cbar_label</strong> (<em>str</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>cbar_orientation</strong> (<em>str</em>)</p></li>
+<li><p><strong>show_axes</strong> (<em>bool</em>)</p></li>
+<li><p><strong>display</strong> (<em>bool</em>)</p></li>
+<li><p><strong>figure_size</strong> (<em>tuple</em>)</p></li>
+<li><p><strong>figure_format</strong> (<em>str</em>)</p></li>
+<li><p><strong>figure_font_size</strong> (<em>float</em>)</p></li>
+<li><p><strong>save</strong> (<em>bool</em>)</p></li>
+<li><p><strong>save_path</strong> (<em>str</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>save_name</strong> (<em>str</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>dpi</strong> (<em>int</em>)</p></li>
+<li><p><strong>dark_mode</strong> (<em>bool</em>)</p></li>
+<li><p><strong>verbose</strong> (<em>bool</em>)</p></li>
+</ul>
+</dd>
+</dl>
 </dd></dl>
 
 </section>

diff --git a/rst_files/get_exposure_maps/index.html b/rst_files/get_exposure_maps/index.html
@@ -271,6 +271,26 @@ <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading">
 </dd>
 </dl>
 </section>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>time_range</strong> (<em>list</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>time_zone</strong> (<em>str</em>)</p></li>
+<li><p><strong>interp_method</strong> (<em>str</em>)</p></li>
+<li><p><strong>time_step</strong> (<em>float</em>)</p></li>
+<li><p><strong>ra_range</strong> (<em>list</em>)</p></li>
+<li><p><strong>dec_range</strong> (<em>list</em>)</p></li>
+<li><p><strong>ra_res</strong> (<em>float</em>)</p></li>
+<li><p><strong>dec_res</strong> (<em>float</em>)</p></li>
+<li><p><strong>time_integrate</strong> (<em>float</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>save_exposure_map_file</strong> (<em>bool</em>)</p></li>
+<li><p><strong>save_exposure_map_image</strong> (<em>bool</em>)</p></li>
+<li><p><strong>verbose</strong> (<em>bool</em>)</p></li>
+<li><p><strong>force_compute</strong> (<em>bool</em>)</p></li>
+<li><p><strong>array_to_image_kwargs</strong> (<em>dict</em><em> | </em><em>None</em>)</p></li>
+</ul>
+</dd>
+</dl>
 </dd></dl>
 
 </section>

diff --git a/rst_files/get_lexi_data/index.html b/rst_files/get_lexi_data/index.html
@@ -206,6 +206,20 @@ <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading">
 </dd>
 </dl>
 </section>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>time_range</strong> (<em>list</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>time_zone</strong> (<em>str</em>)</p></li>
+<li><p><strong>time_pad</strong> (<em>float</em>)</p></li>
+<li><p><strong>data_clip</strong> (<em>bool</em>)</p></li>
+<li><p><strong>verbose</strong> (<em>bool</em>)</p></li>
+<li><p><strong>spc_prams</strong> (<em>bool</em>)</p></li>
+<li><p><strong>return_data_type</strong> (<em>str</em>)</p></li>
+<li><p><strong>spc_prams_kwargs</strong> (<em>dict</em><em> | </em><em>None</em>)</p></li>
+</ul>
+</dd>
+</dl>
 </dd></dl>
 
 </section>

diff --git a/rst_files/get_lexi_images/index.html b/rst_files/get_lexi_images/index.html
@@ -263,6 +263,29 @@ <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading">
 </dd>
 </dl>
 </section>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>time_range</strong> (<em>list</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>time_zone</strong> (<em>str</em>)</p></li>
+<li><p><strong>interp_method</strong> (<em>str</em>)</p></li>
+<li><p><strong>time_step</strong> (<em>float</em>)</p></li>
+<li><p><strong>ra_range</strong> (<em>list</em>)</p></li>
+<li><p><strong>dec_range</strong> (<em>list</em>)</p></li>
+<li><p><strong>ra_res</strong> (<em>float</em>)</p></li>
+<li><p><strong>dec_res</strong> (<em>float</em>)</p></li>
+<li><p><strong>time_integrate</strong> (<em>float</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>background_correction_on</strong> (<em>bool</em>)</p></li>
+<li><p><strong>save_exposure_map_file</strong> (<em>bool</em>)</p></li>
+<li><p><strong>save_exposure_map_image</strong> (<em>bool</em>)</p></li>
+<li><p><strong>save_sky_backgrounds_file</strong> (<em>bool</em>)</p></li>
+<li><p><strong>save_sky_backgrounds_image</strong> (<em>bool</em>)</p></li>
+<li><p><strong>save_lexi_images</strong> (<em>bool</em>)</p></li>
+<li><p><strong>verbose</strong> (<em>bool</em>)</p></li>
+<li><p><strong>array_to_image_kwargs</strong> (<em>dict</em><em> | </em><em>None</em>)</p></li>
+</ul>
+</dd>
+</dl>
 </dd></dl>
 
 </section>

diff --git a/rst_files/get_sky_backgrounds/index.html b/rst_files/get_sky_backgrounds/index.html
@@ -274,6 +274,28 @@ <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading">
 </dd>
 </dl>
 </section>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>time_range</strong> (<em>list</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>time_zone</strong> (<em>str</em>)</p></li>
+<li><p><strong>interp_method</strong> (<em>str</em>)</p></li>
+<li><p><strong>time_step</strong> (<em>float</em>)</p></li>
+<li><p><strong>time_integrate</strong> (<em>float</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>ra_range</strong> (<em>list</em>)</p></li>
+<li><p><strong>dec_range</strong> (<em>list</em>)</p></li>
+<li><p><strong>ra_res</strong> (<em>float</em>)</p></li>
+<li><p><strong>dec_res</strong> (<em>float</em>)</p></li>
+<li><p><strong>save_exposure_map_file</strong> (<em>bool</em>)</p></li>
+<li><p><strong>save_exposure_map_image</strong> (<em>bool</em>)</p></li>
+<li><p><strong>save_sky_backgrounds_file</strong> (<em>bool</em>)</p></li>
+<li><p><strong>save_sky_backgrounds_image</strong> (<em>bool</em>)</p></li>
+<li><p><strong>verbose</strong> (<em>bool</em>)</p></li>
+<li><p><strong>force_compute</strong> (<em>bool</em>)</p></li>
+<li><p><strong>array_to_image_kwargs</strong> (<em>dict</em><em> | </em><em>None</em>)</p></li>
+</ul>
+</dd>
+</dl>
 </dd></dl>
 
 </section>

diff --git a/rst_files/get_spc_prams/index.html b/rst_files/get_spc_prams/index.html
@@ -211,6 +211,22 @@ <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading">
 </dd>
 </dl>
 </section>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><ul class="simple">
+<li><p><strong>time_range</strong> (<em>list</em><em> | </em><em>None</em>)</p></li>
+<li><p><strong>time_zone</strong> (<em>str</em>)</p></li>
+<li><p><strong>time_step</strong> (<em>float</em>)</p></li>
+<li><p><strong>time_pad</strong> (<em>float</em>)</p></li>
+<li><p><strong>data_clip</strong> (<em>bool</em>)</p></li>
+<li><p><strong>interp_method</strong> (<em>str</em>)</p></li>
+<li><p><strong>verbose</strong> (<em>bool</em>)</p></li>
+<li><p><strong>lexi_data</strong> (<em>bool</em>)</p></li>
+<li><p><strong>return_data_type</strong> (<em>str</em>)</p></li>
+<li><p><strong>lexi_data_kwargs</strong> (<em>dict</em><em> | </em><em>None</em>)</p></li>
+</ul>
+</dd>
+</dl>
 </dd></dl>
 
 </section>

diff --git a/rst_files/vignette/index.html b/rst_files/vignette/index.html
@@ -160,6 +160,11 @@ <h2>Returns<a class="headerlink" href="#returns" title="Link to this heading">
 </dd>
 </dl>
 </section>
+<dl class="field-list simple">
+<dt class="field-odd">Parameters<span class="colon">:</span></dt>
+<dd class="field-odd"><p><strong>d</strong> (<em>float</em>)</p>
+</dd>
+</dl>
 </dd></dl>
 
 </section>