Skip to content

Commit

Permalink
Update workflow documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
qudsiramiz committed Dec 31, 2024
1 parent 17fb374 commit eb8098b
Show file tree
Hide file tree
Showing 26 changed files with 269 additions and 1,644 deletions.
12 changes: 12 additions & 0 deletions _sources/install.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,18 @@ You can deactivate the virtual environment by running the following command:
Installing Lexi
---------------
There are three ways to install Lexi: from pypi, from source, and from a local copy.

Installing from PyPI
~~~~~~~~~~~~~~~~~~~~~

After you have created and activated your virtual environment, you can install Lexi from PyPI by
running the following command:

.. code-block:: bash
pip install lexi_bu
Installing from Source
~~~~~~~~~~~~~~~~~~~~~~
Expand Down
8 changes: 4 additions & 4 deletions _sources/rst_files/array_to_image/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

===================
Array to Image (`lexi.lexi.array_to_image`)
===================
========================================
Array to Image (`lexi_bu.lexi.array_to_image`)
========================================

.. py:currentmodule:: lexi.lexi
.. py:currentmodule:: lexi_bu.lexi
.. autofunction:: array_to_image
8 changes: 4 additions & 4 deletions _sources/rst_files/download_files_from_github/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

===================
Download Files from GitHub (`lexi.lexi.download_files_from_github`)
===================
========================================
Download Files from GitHub (`lexi_bu.lexi.download_files_from_github`)
========================================

.. py:currentmodule:: lexi.lexi
.. py:currentmodule:: lexi_bu.lexi
.. autofunction:: download_files_from_github
8 changes: 4 additions & 4 deletions _sources/rst_files/get_exposure_maps/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

===================
Get Exposure Maps (`lexi.lexi.get_exposure_maps`)
===================
========================================
Get Exposure Maps (`lexi_bu.lexi.get_exposure_maps`)
========================================

.. py:currentmodule:: lexi.lexi
.. py:currentmodule:: lexi_bu.lexi
.. autofunction:: get_exposure_maps
8 changes: 4 additions & 4 deletions _sources/rst_files/get_lexi_data/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

===================
Get LEXI Data (`lexi.lexi.get_lexi_data`)
===================
========================================
Get LEXI Data (`lexi_bu.lexi.get_lexi_data`)
========================================

.. py:currentmodule:: lexi.lexi
.. py:currentmodule:: lexi_bu.lexi
.. autofunction:: get_lexi_data
8 changes: 4 additions & 4 deletions _sources/rst_files/get_lexi_images/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

===================
Get LEXI Images (`lexi.lexi.get_lexi_images`)
===================
========================================
Get LEXI Images (`lexi_bu.lexi.get_lexi_images`)
========================================

.. py:currentmodule:: lexi.lexi
.. py:currentmodule:: lexi_bu.lexi
.. autofunction:: get_lexi_images
8 changes: 4 additions & 4 deletions _sources/rst_files/get_sky_backgrounds/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

===================
Get Sky Backgrounds (`lexi.lexi.get_sky_backgrounds`)
===================
========================================
Get Sky Backgrounds (`lexi_bu.lexi.get_sky_backgrounds`)
========================================

.. py:currentmodule:: lexi.lexi
.. py:currentmodule:: lexi_bu.lexi
.. autofunction:: get_sky_backgrounds
8 changes: 4 additions & 4 deletions _sources/rst_files/get_spc_prams/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

===================
Get Spacecraft Parameters (`lexi.lexi.get_spc_prams`)
===================
========================================
Get Spacecraft Parameters (`lexi_bu.lexi.get_spc_prams`)
========================================

.. py:currentmodule:: lexi.lexi
.. py:currentmodule:: lexi_bu.lexi
.. autofunction:: get_spc_prams
8 changes: 4 additions & 4 deletions _sources/rst_files/validate_input/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

===================
Validate Input (`lexi.lexi.validate_input`)
===================
========================================
Validate Input (`lexi_bu.lexi.validate_input`)
========================================

.. py:currentmodule:: lexi.lexi
.. py:currentmodule:: lexi_bu.lexi
.. autofunction:: validate_input
8 changes: 4 additions & 4 deletions _sources/rst_files/vignette/index.rst.txt
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@

===================
Vignette (`lexi.lexi.vignette`)
===================
========================================
Vignette (`lexi_bu.lexi.vignette`)
========================================

.. py:currentmodule:: lexi.lexi
.. py:currentmodule:: lexi_bu.lexi
.. autofunction:: vignette
96 changes: 10 additions & 86 deletions genindex.html
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="install.html#installing-lexi">Installing Lexi</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#installing-from-pypi">Installing from PyPI</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#installing-from-source">Installing from Source</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#installing-from-a-local-copy">Installing from a Local Copy</a></li>
</ul>
Expand All @@ -74,42 +75,15 @@
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">Functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_spc_prams/index.html">Get Spacecraft Prams</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/get_spc_prams/index.html#lexi.lexi.get_spc_prams"><code class="docutils literal notranslate"><span class="pre">get_spc_prams()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/download_files_from_github/index.html">Download Files from GitHub</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/download_files_from_github/index.html#lexi.lexi.download_files_from_github"><code class="docutils literal notranslate"><span class="pre">download_files_from_github()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_exposure_maps/index.html">Get Exposure Maps</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/get_exposure_maps/index.html#lexi.lexi.get_exposure_maps"><code class="docutils literal notranslate"><span class="pre">get_exposure_maps()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_lexi_data/index.html">Get LEXI Data</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/get_lexi_data/index.html#lexi.lexi.get_lexi_data"><code class="docutils literal notranslate"><span class="pre">get_lexi_data()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_lexi_images/index.html">Get LEXI Images</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/get_lexi_images/index.html#lexi.lexi.get_lexi_images"><code class="docutils literal notranslate"><span class="pre">get_lexi_images()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_sky_backgrounds/index.html">Get Sky Backgrounds</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/get_sky_backgrounds/index.html#lexi.lexi.get_sky_backgrounds"><code class="docutils literal notranslate"><span class="pre">get_sky_backgrounds()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/array_to_image/index.html">Array to Image</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/array_to_image/index.html#lexi.lexi.array_to_image"><code class="docutils literal notranslate"><span class="pre">array_to_image()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/validate_input/index.html">Validate Input</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/validate_input/index.html#lexi.lexi.validate_input"><code class="docutils literal notranslate"><span class="pre">validate_input()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/vignette/index.html">Vignette</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/vignette/index.html#lexi.lexi.vignette"><code class="docutils literal notranslate"><span class="pre">vignette()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_spc_prams/index.html">Get Spacecraft Prams</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/download_files_from_github/index.html">Download Files from GitHub</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_exposure_maps/index.html">Get Exposure Maps</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_lexi_data/index.html">Get LEXI Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_lexi_images/index.html">Get LEXI Images</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_sky_backgrounds/index.html">Get Sky Backgrounds</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/array_to_image/index.html">Array to Image</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/validate_input/index.html">Validate Input</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/vignette/index.html">Vignette</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -142,58 +116,8 @@
<h1 id="index">Index</h1>

<div class="genindex-jumpbox">
<a href="#A"><strong>A</strong></a>
| <a href="#D"><strong>D</strong></a>
| <a href="#G"><strong>G</strong></a>
| <a href="#V"><strong>V</strong></a>

</div>
<h2 id="A">A</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rst_files/array_to_image/index.html#lexi.lexi.array_to_image">array_to_image() (in module lexi.lexi)</a>
</li>
</ul></td>
</tr></table>

<h2 id="D">D</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rst_files/download_files_from_github/index.html#lexi.lexi.download_files_from_github">download_files_from_github() (in module lexi.lexi)</a>
</li>
</ul></td>
</tr></table>

<h2 id="G">G</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rst_files/get_exposure_maps/index.html#lexi.lexi.get_exposure_maps">get_exposure_maps() (in module lexi.lexi)</a>
</li>
<li><a href="rst_files/get_lexi_data/index.html#lexi.lexi.get_lexi_data">get_lexi_data() (in module lexi.lexi)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rst_files/get_lexi_images/index.html#lexi.lexi.get_lexi_images">get_lexi_images() (in module lexi.lexi)</a>
</li>
<li><a href="rst_files/get_sky_backgrounds/index.html#lexi.lexi.get_sky_backgrounds">get_sky_backgrounds() (in module lexi.lexi)</a>
</li>
<li><a href="rst_files/get_spc_prams/index.html#lexi.lexi.get_spc_prams">get_spc_prams() (in module lexi.lexi)</a>
</li>
</ul></td>
</tr></table>

<h2 id="V">V</h2>
<table style="width: 100%" class="indextable genindextable"><tr>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rst_files/validate_input/index.html#lexi.lexi.validate_input">validate_input() (in module lexi.lexi)</a>
</li>
</ul></td>
<td style="width: 33%; vertical-align: top;"><ul>
<li><a href="rst_files/vignette/index.html#lexi.lexi.vignette">vignette() (in module lexi.lexi)</a>
</li>
</ul></td>
</tr></table>



</div>
Expand Down
47 changes: 11 additions & 36 deletions index.html
Original file line number Diff line number Diff line change
Expand Up @@ -62,6 +62,7 @@
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="install.html#installing-lexi">Installing Lexi</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#installing-from-pypi">Installing from PyPI</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#installing-from-source">Installing from Source</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#installing-from-a-local-copy">Installing from a Local Copy</a></li>
</ul>
Expand All @@ -76,42 +77,15 @@
</ul>
<ul>
<li class="toctree-l1"><a class="reference internal" href="modules.html">Functions</a><ul>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_spc_prams/index.html">Get Spacecraft Prams</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/get_spc_prams/index.html#lexi.lexi.get_spc_prams"><code class="docutils literal notranslate"><span class="pre">get_spc_prams()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/download_files_from_github/index.html">Download Files from GitHub</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/download_files_from_github/index.html#lexi.lexi.download_files_from_github"><code class="docutils literal notranslate"><span class="pre">download_files_from_github()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_exposure_maps/index.html">Get Exposure Maps</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/get_exposure_maps/index.html#lexi.lexi.get_exposure_maps"><code class="docutils literal notranslate"><span class="pre">get_exposure_maps()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_lexi_data/index.html">Get LEXI Data</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/get_lexi_data/index.html#lexi.lexi.get_lexi_data"><code class="docutils literal notranslate"><span class="pre">get_lexi_data()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_lexi_images/index.html">Get LEXI Images</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/get_lexi_images/index.html#lexi.lexi.get_lexi_images"><code class="docutils literal notranslate"><span class="pre">get_lexi_images()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_sky_backgrounds/index.html">Get Sky Backgrounds</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/get_sky_backgrounds/index.html#lexi.lexi.get_sky_backgrounds"><code class="docutils literal notranslate"><span class="pre">get_sky_backgrounds()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/array_to_image/index.html">Array to Image</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/array_to_image/index.html#lexi.lexi.array_to_image"><code class="docutils literal notranslate"><span class="pre">array_to_image()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/validate_input/index.html">Validate Input</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/validate_input/index.html#lexi.lexi.validate_input"><code class="docutils literal notranslate"><span class="pre">validate_input()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/vignette/index.html">Vignette</a><ul>
<li class="toctree-l3"><a class="reference internal" href="rst_files/vignette/index.html#lexi.lexi.vignette"><code class="docutils literal notranslate"><span class="pre">vignette()</span></code></a></li>
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_spc_prams/index.html">Get Spacecraft Prams</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/download_files_from_github/index.html">Download Files from GitHub</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_exposure_maps/index.html">Get Exposure Maps</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_lexi_data/index.html">Get LEXI Data</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_lexi_images/index.html">Get LEXI Images</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/get_sky_backgrounds/index.html">Get Sky Backgrounds</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/array_to_image/index.html">Array to Image</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/validate_input/index.html">Validate Input</a></li>
<li class="toctree-l2"><a class="reference internal" href="rst_files/vignette/index.html">Vignette</a></li>
</ul>
</li>
</ul>
Expand Down Expand Up @@ -168,6 +142,7 @@ <h2>Contents<a class="headerlink" href="#contents" title="Link to this heading">
</ul>
</li>
<li class="toctree-l2"><a class="reference internal" href="install.html#installing-lexi">Installing Lexi</a><ul>
<li class="toctree-l3"><a class="reference internal" href="install.html#installing-from-pypi">Installing from PyPI</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#installing-from-source">Installing from Source</a></li>
<li class="toctree-l3"><a class="reference internal" href="install.html#installing-from-a-local-copy">Installing from a Local Copy</a></li>
</ul>
Expand Down
Loading

0 comments on commit eb8098b

Please sign in to comment.