config docs added

.github/workflows/main.yml

@@ -61,6 +61,7 @@ jobs:
             echo "Branch $BRANCH did not exist in $PACKAGE"
           else
             echo "Branch $BRANCH did exist in $PACKAGE"
+            git fetch
             git checkout $BRANCH
           fi
           popd

MANIFEST.in

@@ -1,8 +1,22 @@
 # MANIFEST.in
+exclude .gitignore
+include README.rst
+include setup.cfg
+include CITATIONS.rst
+include LICENSE
 include requirements.txt
+include optional_requirements.txt
 
-global-exclude test_autoarray
-recursive-exclude test_autoarray *
+prune .cache
+prune .git
+prune build
+prune dist
+
+recursive-exclude *.egg-info *
+
+recursive-include autoarray/config *
 
-recursive-include data *
-recursive-include autoarray/config *
+exclude docs
+
+global-exclude test_autoarray
+recursive-exclude test_autoarray *

autoarray/__init__.py

@@ -84,4 +84,4 @@
 
 conf.instance.register(__file__)
 
-__version__ = "2022.07.11.1"
+__version__ = "2022.11.26.11"

autoarray/config/general.yaml

@@ -1,15 +1,15 @@
 fits:
-  flip_for_ds9: false
+  flip_for_ds9: false                             # If True, a np.flipud() is applied to images before loading so visualization is the same orientation as ds9
 grid:
-  remove_projected_centre: false
-numba:
-  cache: false
-  nopython: true
-  parallel: false
-  use_numba: true
+  remove_projected_centre: false                 # When making 1D data structures from 2D data structures (e.g. Grid1D from Grid2D), whether the central pixel is removed or not.
+numba:                                           # These are the input variables of the numba.jit() decorator, which are applied to many functions throughout the source code.
+  use_numba: true                                # If True, numba is used by the source code. This allows one to disable numba, albeit the source code will run slower.
+  cache: false                                   # If True, the numba just in time compilations are cached.
+  nopython: true                                 # If True, numba raises an exception if jit-compiled code is in Python.
+  parallel: false                                # If True, numba perform parallel multithreading.
 pixelization:
-  voronoi_nn_max_interpolation_neighbors: 100
+  voronoi_nn_max_interpolation_neighbors: 100    # The maximum number of neighbors a Voronoi pixel in the natural neighbor interpolation scheme is allowed (e.g. VoronoiNNMagnification)
 profiling:
-  repeats: 1
+  repeats: 1                                     # The number of repeat function calls used to measure run-times when profiling.
 structures:
-  use_dataset_grids: true
+  use_dataset_grids: true                        # If True, dataset objects (e.g. Imaging) have a grid of (y,x) coordinates computed for them.