Add corrections

README.md

@@ -10,20 +10,6 @@ This repository holds the code of VAST Post Processing.
 
 ## Screenshots and Previews
 
-## Documentation
-
-To view `sphinx` documentation for this project, navigate to the root of the package, and
-enter the following commands - 
-```
-poetry install
-poetry shell
-cd docs
-make html
-```
-The pages will be built in `vast-post-processing/docs/build/html`, and you can
-load the index page by opening `index.html` in a browser.
-
-
 ## Contributors
 
 * Andrew O'Brien – [Department of Physics, University of Wisconsin-Milwaukee](https://uwm.edu/physics/research/astronomy-gravitation-cosmology/)

docker/README.md

@@ -0,0 +1,10 @@
+# Docker
+
+This directory contains the relevant Docker files for this project's Docker
+services. 
+
+## Included
+
+1. `.dockerignore`
+2. `build_singularity.sh`
+3. `Dockerfile`

docs/README.md

@@ -0,0 +1,35 @@
+# Documentation
+
+This directory contains the documentation for this project. 
+
+The modules of this project are documented using docstrings
+in [numpydoc](https://numpydoc.readthedocs.io/en/latest/format.html) style and
+comments, and formatted using code blocking, parentheses, and other
+[PEP8](https://peps.python.org/pep-0008/) style guidelines, using [the Black
+formatter](https://black.readthedocs.io/en/stable/the_black_code_style/current_style.html). 
+
+They are auto-generated in `HTML` format with [`sphinx`](https://www.sphinx-doc.org/en/master/index.html). 
+
+## Included
+
+1. `source/`
+    1. `conf.py`
+    2. `index.rst`
+    3. `modules.rst`
+    4. `vast_post_processing.rst`
+2. `make.bat`
+3. `Makefile`
+
+## Instructions
+
+To view `sphinx` documentation for this project, navigate to the root of the
+package (i.e. `vast-post-processing`), and
+run
+```
+poetry install
+poetry shell
+cd docs
+make html
+```
+The pages are built in `vast-post-processing/docs/build/html`, and you can load
+the index page by opening `index.html` in a browser. 

examples/README.md

@@ -0,0 +1,15 @@
+# Examples
+
+This directory contains program runtime examples. 
+
+## Included
+
+1. `mortimer/`
+    1. `01-convolve_neighbours.sbatch`
+    2. `02-swarp.sbatch`
+    3. `03-selavy_setup.sbatch`
+    4. `04-selavy_submit.sbatch`
+    5. `05-rsync_outputs.sh`
+    6. `field_list.txt`
+    7. `selavy_template.in`
+    8. `selavy_template.sbatch`

scripts/README.md

@@ -0,0 +1,7 @@
+# Scripts
+
+This directory contains standalone scripts. 
+
+## Included
+
+1. `combined-fix-timestamps`

vast_post_processing/__init__.py

@@ -0,0 +1,8 @@
+import combine
+import corrections
+import crop
+import neighbours
+import validation
+
+import utils
+import cli