Merge pull request #8 from mrileyowens:docs/add-docs

Added dedicated documentation to the project
mrileyowens · Aug 11, 2024 · 02c5117 · 02c5117
2 parents 6437e6e + 3307f60
commit 02c5117
Show file tree

Hide file tree

Showing 7 changed files with 159 additions and 4 deletions.
diff --git a/.gitignore b/.gitignore
diff --git a/docs/flow.pdf b/docs/flow.pdf
diff --git a/docs/flow.svg b/docs/flow.svg
diff --git a/docs/overview.md b/docs/overview.md
diff --git a/docs/readme.md b/docs/readme.md
@@ -0,0 +1,7 @@
+# Software release for *Connecting Lyman-α and ionizing photon escape in the Sunburst Arc*
+
+This is a respository containing the underlying software used to create the results in the journal article *Connecting Lyman-α and ionizing photon escape in the Sunburst Arc*, led by [M. Riley Owens](https://mrileyowens.github.io) and submitted to *The Astrophysical Journal*.
+
+For details about the files and structure of this repository, consult `docs/overview.md`.
+
+For questions or issues, please contact [M. Riley Owens](https://mrileyowens.github.io) at m.riley.owens@gmail.com.
diff --git a/docs/tasks.md b/docs/tasks.md
@@ -0,0 +1,12 @@
+### Open
+
+- [ ] Determine the units of the Lyα maps and verify the units stated in the documentation and code comments 
+- [ ] Add horizontal lines separating the LyC-leaking and non-LyC-leaking MagE slit apertures in tables
+- [ ] Update the article's methodology with new details about the MC simulation process
+- [ ] Create a virtual environment with the latest Python and package versions and execute the project's code with the environment
+- [ ] Create a `requirements.txt` file listing the package versions the project uses
+- [ ] Confirm that all uses of the stacked spectra use the correct and current version produced by `stack.ipynb`
+- [ ] Add the descriptions of `nb.ipynb` and `seeing.ipynb` once the results of `seeing.ipynb` are satisfactory
+- [ ] Update the convolution in `esc.ipynb` to also include the effect of airmass
+
+### Closed
diff --git a/lya.ipynb b/lya.ipynb
@@ -1595,8 +1595,7 @@
     "        # Add the formatted parameter measurement to the table row\n",
     "        table = table + f'& ${median}_{{-{lower}}}^{{+{upper}}}$ '\n",
     "\n",
-    "        # Add an aesthetic, dividing '/' after the formatted parameter \n",
-    "        # measurement, unless it is the last parameter in the loop\n",
+    "        # Add a LaTeX row break character if the row is not the last, and a line break character to the string\n",
     "        table = table + '\\\\\\\\\\n' if i != len(slits) - 1 else table + '\\n'\n",
     "\n",
     "    # Add a footer to the table\n",