Update workflow documentation

Lexi-BU · Dec 31, 2024 · 0b477d9 · 0b477d9
1 parent 36b5957
commit 0b477d9
Show file tree

Hide file tree

Showing 10 changed files with 40 additions and 40 deletions.
diff --git a/docs/_build/doctrees/environment.pickle b/docs/_build/doctrees/environment.pickle
diff --git a/docs/_build/doctrees/install.doctree b/docs/_build/doctrees/install.doctree
diff --git a/docs/_build/html/_sources/install.rst.txt b/docs/_build/html/_sources/install.rst.txt
@@ -96,7 +96,7 @@ by following these steps:
 1. Download `lexi-version.tar.gz` directory from the following link: `Download LEXI Software <https://lexi-bu.github.io/software/dist/lexi-0.0.1.tar.gz>`_
 
 2. Copy the `lexi-version.tar.gz` file into `Documents/lexi` (or any other directory where you want
-   to install Lexi in).
+   to install lexi in).
 
 3. Activate your virtual environment using the instructions above.
 
@@ -115,13 +115,13 @@ You can verify that Lexi was installed by running the following command:
 
 .. code-block:: bash
 
-    pip show lexi
+    pip show lexi_bu
 
 This should produce output similar to the following:
 
 .. code-block::
 
-    Name: lexi
+    Name: lexi_bu
     Version: 0.0.1
     Summary: Main repository for all data analysis related to LEXI
     Home-page: 
@@ -146,7 +146,7 @@ This should produce output similar to the following:
     --------------- -------
     .....................
     kiwisolver      1.4.5
-    lexi            0.0.1
+    lexi_bu         0.0.1
     matplotlib      3.8.2
     numpy           1.26.4
     .....................
@@ -156,7 +156,7 @@ You can open a Python shell and import Lexi by running the following commands:
 .. code-block:: bash
 
     python
-    import lexi
+    import lexi_bu as lexi
     lexi.__version__
 
 This should produce output similar to the following:

diff --git a/docs/_build/html/install.html b/docs/_build/html/install.html
@@ -222,7 +222,7 @@ <h3>Installing from a Local Copy<a class="headerlink" href="#installing-from-a-l
 <ol class="arabic simple">
 <li><p>Download <cite>lexi-version.tar.gz</cite> directory from the following link: <a class="reference external" href="https://lexi-bu.github.io/software/dist/lexi-0.0.1.tar.gz">Download LEXI Software</a></p></li>
 <li><p>Copy the <cite>lexi-version.tar.gz</cite> file into <cite>Documents/lexi</cite> (or any other directory where you want
-to install Lexi in).</p></li>
+to install lexi in).</p></li>
 <li><p>Activate your virtual environment using the instructions above.</p></li>
 <li><p>Install Lexi by running the following command (replace <code class="docutils literal notranslate"><span class="pre">lexi-version.tar.gz</span></code> with the actual name of the file you downloaded):</p></li>
 </ol>
@@ -236,11 +236,11 @@ <h3>Installing from a Local Copy<a class="headerlink" href="#installing-from-a-l
 <section id="verifying-the-installation">
 <h1>Verifying the Installation<a class="headerlink" href="#verifying-the-installation" title="Link to this heading"></a></h1>
 <p>You can verify that Lexi was installed by running the following command:</p>
-<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>show<span class="w"> </span>lexi
+<div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>pip<span class="w"> </span>show<span class="w"> </span>lexi_bu
 </pre></div>
 </div>
 <p>This should produce output similar to the following:</p>
-<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Name</span><span class="p">:</span> <span class="n">lexi</span>
+<div class="highlight-default notranslate"><div class="highlight"><pre><span></span><span class="n">Name</span><span class="p">:</span> <span class="n">lexi_bu</span>
 <span class="n">Version</span><span class="p">:</span> <span class="mf">0.0.1</span>
 <span class="n">Summary</span><span class="p">:</span> <span class="n">Main</span> <span class="n">repository</span> <span class="k">for</span> <span class="nb">all</span> <span class="n">data</span> <span class="n">analysis</span> <span class="n">related</span> <span class="n">to</span> <span class="n">LEXI</span>
 <span class="n">Home</span><span class="o">-</span><span class="n">page</span><span class="p">:</span>
@@ -261,15 +261,15 @@ <h1>Verifying the Installation<a class="headerlink" href="#verifying-the-install
 ---------------<span class="w"> </span>-------
 .....................
 kiwisolver<span class="w">      </span><span class="m">1</span>.4.5
-lexi<span class="w">            </span><span class="m">0</span>.0.1
+lexi_bu<span class="w">         </span><span class="m">0</span>.0.1
 matplotlib<span class="w">      </span><span class="m">3</span>.8.2
 numpy<span class="w">           </span><span class="m">1</span>.26.4
 .....................
 </pre></div>
 </div>
 <p>You can open a Python shell and import Lexi by running the following commands:</p>
 <div class="highlight-bash notranslate"><div class="highlight"><pre><span></span>python
-import<span class="w"> </span>lexi
+import<span class="w"> </span>lexi_bu<span class="w"> </span>as<span class="w"> </span>lexi
 lexi.__version__
 </pre></div>
 </div>

diff --git a/docs/_build/jupyter_execute/rst_files/array_to_image/index.ipynb b/docs/_build/jupyter_execute/rst_files/array_to_image/index.ipynb
@@ -3,13 +3,13 @@
   {
    "cell_type": "code",
    "execution_count": 1,
-   "id": "bfb3af08",
+   "id": "c760f72c",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-12-31T17:38:23.100546Z",
-     "iopub.status.busy": "2024-12-31T17:38:23.100256Z",
-     "iopub.status.idle": "2024-12-31T17:38:23.548358Z",
-     "shell.execute_reply": "2024-12-31T17:38:23.547690Z"
+     "iopub.execute_input": "2024-12-31T18:59:26.347758Z",
+     "iopub.status.busy": "2024-12-31T18:59:26.347330Z",
+     "iopub.status.idle": "2024-12-31T18:59:26.820488Z",
+     "shell.execute_reply": "2024-12-31T18:59:26.819994Z"
     }
    },
    "outputs": [

diff --git a/docs/_build/jupyter_execute/rst_files/get_exposure_maps/index.ipynb b/docs/_build/jupyter_execute/rst_files/get_exposure_maps/index.ipynb
@@ -3,13 +3,13 @@
   {
    "cell_type": "code",
    "execution_count": 1,
-   "id": "69e3a100",
+   "id": "10ae02f8",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-12-31T17:38:24.504349Z",
-     "iopub.status.busy": "2024-12-31T17:38:24.503801Z",
-     "iopub.status.idle": "2024-12-31T17:38:42.227658Z",
-     "shell.execute_reply": "2024-12-31T17:38:42.227241Z"
+     "iopub.execute_input": "2024-12-31T18:59:28.063842Z",
+     "iopub.status.busy": "2024-12-31T18:59:28.063403Z",
+     "iopub.status.idle": "2024-12-31T18:59:45.528350Z",
+     "shell.execute_reply": "2024-12-31T18:59:45.527804Z"
     }
    },
    "outputs": [

diff --git a/docs/_build/jupyter_execute/rst_files/get_lexi_data/index.ipynb b/docs/_build/jupyter_execute/rst_files/get_lexi_data/index.ipynb
@@ -3,13 +3,13 @@
   {
    "cell_type": "code",
    "execution_count": 1,
-   "id": "4c984c4e",
+   "id": "100d4fb3",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-12-31T17:38:43.525155Z",
-     "iopub.status.busy": "2024-12-31T17:38:43.524265Z",
-     "iopub.status.idle": "2024-12-31T17:38:44.996299Z",
-     "shell.execute_reply": "2024-12-31T17:38:44.995404Z"
+     "iopub.execute_input": "2024-12-31T18:59:46.742015Z",
+     "iopub.status.busy": "2024-12-31T18:59:46.741642Z",
+     "iopub.status.idle": "2024-12-31T18:59:48.289041Z",
+     "shell.execute_reply": "2024-12-31T18:59:48.288104Z"
     }
    },
    "outputs": [

diff --git a/docs/_build/jupyter_execute/rst_files/get_lexi_images/index.ipynb b/docs/_build/jupyter_execute/rst_files/get_lexi_images/index.ipynb
@@ -3,13 +3,13 @@
   {
    "cell_type": "code",
    "execution_count": 1,
-   "id": "a813ced1",
+   "id": "9dc4cd83",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-12-31T17:38:46.298460Z",
-     "iopub.status.busy": "2024-12-31T17:38:46.297398Z",
-     "iopub.status.idle": "2024-12-31T17:38:48.625136Z",
-     "shell.execute_reply": "2024-12-31T17:38:48.624283Z"
+     "iopub.execute_input": "2024-12-31T18:59:49.604915Z",
+     "iopub.status.busy": "2024-12-31T18:59:49.603469Z",
+     "iopub.status.idle": "2024-12-31T18:59:51.766504Z",
+     "shell.execute_reply": "2024-12-31T18:59:51.765902Z"
     }
    },
    "outputs": [

diff --git a/docs/_build/jupyter_execute/rst_files/get_sky_backgrounds/index.ipynb b/docs/_build/jupyter_execute/rst_files/get_sky_backgrounds/index.ipynb
@@ -3,13 +3,13 @@
   {
    "cell_type": "code",
    "execution_count": 1,
-   "id": "f9c1cb0f",
+   "id": "caef1bbc",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-12-31T17:38:50.186362Z",
-     "iopub.status.busy": "2024-12-31T17:38:50.185936Z",
-     "iopub.status.idle": "2024-12-31T17:39:14.608476Z",
-     "shell.execute_reply": "2024-12-31T17:39:14.607912Z"
+     "iopub.execute_input": "2024-12-31T18:59:52.980310Z",
+     "iopub.status.busy": "2024-12-31T18:59:52.979770Z",
+     "iopub.status.idle": "2024-12-31T19:00:14.847266Z",
+     "shell.execute_reply": "2024-12-31T19:00:14.846651Z"
     }
    },
    "outputs": [

diff --git a/docs/_build/jupyter_execute/rst_files/get_spc_prams/index.ipynb b/docs/_build/jupyter_execute/rst_files/get_spc_prams/index.ipynb
@@ -3,13 +3,13 @@
   {
    "cell_type": "code",
    "execution_count": 1,
-   "id": "21260366",
+   "id": "a6015423",
    "metadata": {
     "execution": {
-     "iopub.execute_input": "2024-12-31T17:39:15.891745Z",
-     "iopub.status.busy": "2024-12-31T17:39:15.891399Z",
-     "iopub.status.idle": "2024-12-31T17:39:16.403957Z",
-     "shell.execute_reply": "2024-12-31T17:39:16.403249Z"
+     "iopub.execute_input": "2024-12-31T19:00:16.126658Z",
+     "iopub.status.busy": "2024-12-31T19:00:16.126372Z",
+     "iopub.status.idle": "2024-12-31T19:00:16.721277Z",
+     "shell.execute_reply": "2024-12-31T19:00:16.720700Z"
     }
    },
    "outputs": [